diff --git a/.github/workflows/build-dereferenced-beta-spec.yml b/.github/workflows/build-dereferenced-beta-spec.yml index 2fa3f73..996c0f4 100644 --- a/.github/workflows/build-dereferenced-beta-spec.yml +++ b/.github/workflows/build-dereferenced-beta-spec.yml @@ -19,10 +19,13 @@ jobs: uses: actions/setup-node@v3 with: node-version: "16" - - name: Install swagger-cli + - name: Install swagger-cli and postman run: | npm install -g swagger-cli + npm install -g openapi-to-postmanv2 - name: Dereference Beta API Specification run: | swagger-cli bundle --dereference idn/sailpoint-api.beta.yaml -t yaml -o dereferenced/deref-sailpoint-api.beta.yaml + openapi2postmanv2 -s dereferenced/deref-sailpoint-api.beta.yaml -o postman/collections/sailpoint-api-beta.json -p -O folderStrategy=Tags,requestParametersResolution=Schema,exampleParametersResolution=Schema,disableOptionalParameters=true,optimizeConversion=false,stackLimit=50,alwaysInheritAuthentication=true + node postman-script/modify-collection.js postman/collections/sailpoint-api-beta.json - uses: stefanzweifel/git-auto-commit-action@v4 diff --git a/.github/workflows/build-dereferenced-v3-spec.yml b/.github/workflows/build-dereferenced-v3-spec.yml index e388115..9127651 100644 --- a/.github/workflows/build-dereferenced-v3-spec.yml +++ b/.github/workflows/build-dereferenced-v3-spec.yml @@ -18,11 +18,15 @@ jobs: - name: Set up Node uses: actions/setup-node@v3 with: - node-version: "16" - - name: Install swagger-cli + node-version: "18" + - name: Install swagger-cli and postman run: | npm install -g swagger-cli + npm install -g openapi-to-postmanv2 - name: Dereference API Specification run: | swagger-cli bundle --dereference idn/sailpoint-api.v3.yaml -t yaml -o dereferenced/deref-sailpoint-api.v3.yaml + openapi2postmanv2 -s dereferenced/deref-sailpoint-api.v3.yaml -o postman/collections/sailpoint-api-v3.json -p -O folderStrategy=Tags,requestParametersResolution=Schema,exampleParametersResolution=Schema,disableOptionalParameters=true,optimizeConversion=false,stackLimit=50,alwaysInheritAuthentication=true + node postman-script/modify-collection.js postman/collections/sailpoint-api-v3.json + - uses: stefanzweifel/git-auto-commit-action@v4 diff --git a/postman-script/base-auth.json b/postman-script/base-auth.json new file mode 100644 index 0000000..449e15d --- /dev/null +++ b/postman-script/base-auth.json @@ -0,0 +1,10 @@ +{ + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{accessToken}}", + "type": "string" + } + ] +} \ No newline at end of file diff --git a/postman-script/modify-collection.js b/postman-script/modify-collection.js new file mode 100644 index 0000000..9d3e2c2 --- /dev/null +++ b/postman-script/modify-collection.js @@ -0,0 +1,48 @@ +const fs = require('fs'); + +// Function to recursively delete "auth" key from an object +const deleteAuthKey = (obj) => { + for (const key in obj) { + if (typeof obj[key] === 'object') { + deleteAuthKey(obj[key]); // Recursive call for nested objects + } + if (key === 'auth') { + delete obj[key]; + } + } + }; + + const args = process.argv; + +// Read the JSON file +fs.readFile(args[2], 'utf8', (err, data) => { + if (err) { + console.error('Error reading the file:', err); + return; + } + + try { + // Parse the JSON content + const jsonObject = JSON.parse(data); + + + + // Delete all occurrences of the key "auth" + deleteAuthKey(jsonObject); + jsonObject.auth = JSON.parse(fs.readFileSync('postman-script/base-auth.json', 'utf8')); + jsonObject.event = JSON.parse(fs.readFileSync('postman-script/pre-script.json', 'utf8')); + jsonObject.variable = JSON.parse(fs.readFileSync('postman-script/variable.json', 'utf8')); + + + // Write the modified JSON content back to the file + fs.writeFile(args[2], JSON.stringify(jsonObject, null, 2), (writeErr) => { + if (writeErr) { + console.error('Error writing the file:', writeErr); + } else { + console.log('Auth keys deleted and file updated successfully.'); + } + }); + } catch (parseError) { + console.error('Error parsing JSON:', parseError); + } +}); \ No newline at end of file diff --git a/postman-script/pre-script.json b/postman-script/pre-script.json new file mode 100644 index 0000000..76a6b62 --- /dev/null +++ b/postman-script/pre-script.json @@ -0,0 +1,65 @@ +[ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "const domain = pm.environment.get('domain') ? pm.environment.get('domain') : pm.collectionVariables.get('domain')", + "const tokenUrl = 'https://' + pm.environment.get('tenant') + '.api.' + domain + '.com/oauth/token';", + "const clientId = pm.environment.get('clientId');", + "const clientSecret = pm.environment.get('clientSecret');", + "", + "const getTokenRequest = {", + " method: 'POST',", + " url: tokenUrl,", + " body: {", + " mode: 'formdata',", + " formdata: [{", + " key: 'grant_type',", + " value: 'client_credentials'", + " },", + " {", + " key: 'client_id',", + " value: clientId", + " },", + " {", + " key: 'client_secret',", + " value: clientSecret", + " }", + " ]", + " }", + "};", + "", + "", + "var moment = require('moment');", + "if (!pm.environment.has('tokenExpTime')) {", + " pm.environment.set('tokenExpTime', moment());", + "}", + "", + "if (moment(pm.environment.get('tokenExpTime')) <= moment() || !pm.environment.get('tokenExpTime') || !pm.environment.get('accessToken')) {", + " var time = moment();", + " time.add(12, 'hours');", + " pm.environment.set('tokenExpTime', time);", + " pm.sendRequest(getTokenRequest, (err, response) => {", + " const jsonResponse = response.json();", + " if (response.code != 200) {", + " throw new Error(`Unable to authenticate: ${JSON.stringify(jsonResponse)}`);", + " }", + " const newAccessToken = jsonResponse.access_token;", + " pm.environment.set('accessToken', newAccessToken);", + " });", + "", + "}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } +] \ No newline at end of file diff --git a/postman-script/variable.json b/postman-script/variable.json new file mode 100644 index 0000000..a3e5d38 --- /dev/null +++ b/postman-script/variable.json @@ -0,0 +1,12 @@ +[ + { + "key": "domain", + "value": "identitynow", + "type": "string" + }, + { + "key": "baseUrl", + "value": "https://{{tenant}}.api.{{domain}}.com", + "type": "string" + } +] \ No newline at end of file diff --git a/postman/collections/sailpoint-api-beta.json b/postman/collections/sailpoint-api-beta.json new file mode 100644 index 0000000..0a279f3 --- /dev/null +++ b/postman/collections/sailpoint-api-beta.json @@ -0,0 +1,177940 @@ +{ + "item": [ + { + "name": "access-profiles", + "description": "", + "item": [ + { + "id": "15d1cab9-7985-4287-a89c-3cf5c4d522ac", + "name": "List Access Profiles", + "request": { + "name": "List Access Profiles", + "description": { + "content": "This API returns a list of Access Profiles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "06cd31b5-83ca-447c-a437-5272f608e52c", + "name": "List of Access Profiles", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n },\n {\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b702dd1-40c4-4a3a-81f0-7cbb95d23bb0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "94dd8a5b-107b-43ba-8f09-2fa3bc77cf31", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "baccaa00-2ba2-40ca-9ece-6f53d60cdbcd", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e7b2d0cc-cd7f-4f27-ad4f-0104d058fc04", + "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": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6c68b4e-56d6-4b17-899f-dc0ce0c5a1ac", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d2e0df6a-6d75-4c7d-b489-57a2d3487995", + "name": "Create an Access Profile", + "request": { + "name": "Create an Access Profile", + "description": { + "content": "This API creates an Access Profile.\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile's Source.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ac1bfefe-ba32-4f88-a244-cc6807c04c25", + "name": "Access Profile created", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "398544a4-7ba0-4ab7-ba91-ad956f01494c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "56448923-4d46-4bba-96b1-524d9ad7ce7f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17c2803b-b06d-4b5f-a8f7-ca0c43c2759d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e01f04cc-8eb5-40a1-b07d-4d8f52d85f3a", + "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": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ea80000-6770-403f-a6d8-6793247b494b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e6bcecc7-80bb-4a95-a7d7-340c3a82e39b", + "name": "Get an Access Profile", + "request": { + "name": "Get an Access Profile", + "description": { + "content": "This API returns an Access Profile by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9c5ef1e2-e667-4526-b2ba-7bc3ea96c18f", + "name": "An AccessProfile", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6dfe7d5f-9494-43b0-91d8-2cc1371dfe48", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "242bfb3d-72d0-4a4f-8458-e1822efb1827", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e187b18-dec0-44ad-a63b-1f15430229c9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9074d5a0-4196-4f4c-bd60-d4bc92e9e6bb", + "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": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74efdd7c-6619-4cb9-a518-196bb15a31a4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b36a5aac-61ce-48cb-b1fb-0ee19d20d2bb", + "name": "Patch a specified Access Profile", + "request": { + "name": "Patch a specified Access Profile", + "description": { + "content": "This API updates an existing Access Profile. The following fields are patchable:\n**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.\n> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.\n\n> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source.\n\n> Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e40bc8f3-6c6b-47da-943e-451a6aad5286", + "name": "Responds with the Access Profile as updated.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "675e248d-7696-47ff-9afa-bb87c3bf6c9e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f106469b-32d6-4332-97ce-a5b3d479bf12", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "993873a8-9415-4dd1-8e02-78272669b7bf", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff376740-7471-4220-858a-508973857aa5", + "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": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b759e805-8acf-403c-8865-5c23c1f65c18", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "34ea2295-4040-4e8b-87a5-81ff5ebf458d", + "name": "Delete the specified Access Profile", + "request": { + "name": "Delete the specified Access Profile", + "description": { + "content": "This API deletes an existing Access Profile.\n\nThe Access Profile must not be in use. If it is, a 400 error is returned.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "82c37c35-e3ae-4f57-bfd8-88b05eb89288", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "83122d47-48e1-4117-a3fd-a2abca7724ec", + "name": "Returned when an access profile cannot be deleted as it's being used.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff5bc261-b0f4-45f0-8dd5-a1588963ddc6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f794f596-552a-40b8-bab5-57d67a11914e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5e276e6b-4f61-4510-aaab-539277827f43", + "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": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef761b78-0416-4ad4-99d6-41c507ab1cc3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "entitlements", + "description": "", + "item": [ + { + "id": "587719ea-1ceb-4581-996d-bdffd2d15e0c", + "name": "List Access Profile's Entitlements", + "request": { + "name": "List Access Profile's Entitlements", + "description": { + "content": "This API lists the Entitlements associated with a given Access Profile\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c2233f7e-478e-4d49-84bd-bad87448cadf", + "name": "List of Entitlements", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"dolore_40\": \"tempor Lorem dolor\",\n \"aute_e\": -44486449.80083678,\n \"est0\": -34337841.86800324\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"ex41\": false,\n \"ut_3\": false,\n \"veniam_3\": \"est minim consectetur\",\n \"aute32\": 15334616.312678099\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0c88efa-e111-44f6-b751-0be7d8cf0fdc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f566648-92eb-4ebe-83e5-e2887bc7b86f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3a73128c-509f-4c4e-825f-e81000faa234", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f8d48f1-9108-46b2-8f6f-f33447b5976c", + "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": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9d307c0d-d73e-44ec-93ca-270993aa140e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "f19c44cf-6d24-4c5f-82b2-d2498aa53765", + "name": "Delete Access Profile(s)", + "request": { + "name": "Delete Access Profile(s)", + "description": { + "content": "This API initiates a bulk deletion of one or more Access Profiles.\n\nBy default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2f27d758-56a7-4c7a-8aeb-d15d06cde746", + "name": "Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"taskId\": \"\",\n \"pending\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35b1442f-2617-47d2-9b6f-f2d7e5564780", + "name": "Returned if at least one deletion will be performed.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"taskId\": \"\",\n \"pending\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0424e42d-7a93-4f7c-8d13-646f09526302", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b89c4a63-39e3-4f09-bb39-5355b13bbe06", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ee41b47-460f-43ad-ade1-bb0a8c023d78", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f961440e-a434-4288-b853-13016b3c3caa", + "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": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5fe11955-1552-4a86-a082-606546dc223a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "access-requests", + "description": "", + "item": [ + { + "id": "3490f583-7059-4bc6-867b-294e962ea15d", + "name": "Submit an Access Request", + "request": { + "name": "Submit an Access Request", + "description": { + "content": "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. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-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 only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate.\n* Roles, Access Profiles, and Entitlements can be requested for revocation.\n* Revoke requests for entitlements are limited to 1 entitlement per access request currently.\n* [Roles, Access Profiles] removeDate can be specified if access don't have a sunset date or if a revoke access with a removeDate earlier than the current endDate.\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\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", + "type": "text/plain" + }, + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"quisf\": \"\",\n \"ad_4\": \"\",\n \"ade\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"ine\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"cillum_21\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "cad08402-2a0f-40e4-a9ab-86334d59d927", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"quisf\": \"\",\n \"ad_4\": \"\",\n \"ade\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"ine\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"cillum_21\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "513d4d6a-f3f0-45cf-93b2-205673b4e4e7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"quisf\": \"\",\n \"ad_4\": \"\",\n \"ade\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"ine\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"cillum_21\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "442bac5a-721d-4bea-8643-c6ef79913fe5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"quisf\": \"\",\n \"ad_4\": \"\",\n \"ade\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"ine\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"cillum_21\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a06c6f97-bebb-4f6f-a984-a7385996eec8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"quisf\": \"\",\n \"ad_4\": \"\",\n \"ade\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"ine\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"cillum_21\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "53f85db7-c7e7-40fd-a83a-e8d0bc1d6f8c", + "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": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"quisf\": \"\",\n \"ad_4\": \"\",\n \"ade\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"ine\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"cillum_21\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efcc1f4c-418e-47f9-bf86-541f7b50d890", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"quisf\": \"\",\n \"ad_4\": \"\",\n \"ade\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"ine\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"GRANT_ACCESS\",\n \"clientMetadata\": {\n \"cillum_21\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "cancel", + "description": "", + "item": [ + { + "id": "d02b5685-bf7b-4ffb-bb01-8f74042727b2", + "name": "Cancel Access Request", + "request": { + "name": "Cancel Access Request", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "31defcc0-1cf2-4414-ab60-ab6c01647d31", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f6e618b-9c27-43a8-836f-a1b85a19b9e4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "075170e4-7b14-455b-9952-d722ce0bec6f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c134d2d8-891a-4766-9c0d-bf80534b9fac", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9e2c4467-c6dc-4755-ba81-fd514f45d4dd", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "056d7189-95d2-4e95-9fdf-ab6371d0a389", + "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": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "86717274-122b-4464-a7be-367a95dc1002", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "close", + "description": "", + "item": [ + { + "id": "4caa05d4-ab7e-4565-a358-411d098c5509", + "name": "Close Access Request", + "request": { + "name": "Close Access Request", + "description": { + "content": "This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle (even after the approval state, unlike Cancel Access Request). A token with ORG_ADMIN authority is required.\n\nTo find pending access requests via the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \"Tracking Number,\" and the Download button to export a CSV containing the Tracking Numbers.\n\nTo find pending access requests via the API, use List Account Activities.\n\nInput the ids from either source\n\nTo track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated, and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the Identity Request IDs that finished in error.\n\nThis API triggers the Provisioning Action Completed event trigger for each access request that is closed.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "access-requests", + "close" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestIds\": [\n \"\",\n \"\"\n ],\n \"message\": \"The IdentityNow Administrator manually closed this request.\",\n \"executionStatus\": \"Terminated\",\n \"completionStatus\": \"Failure\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "5dc9a8e7-3596-4819-a98e-87e2940de537", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "close" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestIds\": [\n \"\",\n \"\"\n ],\n \"message\": \"The IdentityNow Administrator manually closed this request.\",\n \"executionStatus\": \"Terminated\",\n \"completionStatus\": \"Failure\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c230b045-0c9d-4d38-a208-961007ce6c99", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "close" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestIds\": [\n \"\",\n \"\"\n ],\n \"message\": \"The IdentityNow Administrator manually closed this request.\",\n \"executionStatus\": \"Terminated\",\n \"completionStatus\": \"Failure\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "722a8000-25f6-4b07-89b5-746ca8e92ea8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "close" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestIds\": [\n \"\",\n \"\"\n ],\n \"message\": \"The IdentityNow Administrator manually closed this request.\",\n \"executionStatus\": \"Terminated\",\n \"completionStatus\": \"Failure\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5502b6e7-6651-4cf2-b910-c824475160b3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "close" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestIds\": [\n \"\",\n \"\"\n ],\n \"message\": \"The IdentityNow Administrator manually closed this request.\",\n \"executionStatus\": \"Terminated\",\n \"completionStatus\": \"Failure\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "be861022-c289-479f-9d3b-75c9635b6e3a", + "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": { + "url": { + "path": [ + "access-requests", + "close" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestIds\": [\n \"\",\n \"\"\n ],\n \"message\": \"The IdentityNow Administrator manually closed this request.\",\n \"executionStatus\": \"Terminated\",\n \"completionStatus\": \"Failure\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ccb6e8f2-505e-48b0-b8cb-0ea676f13aad", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "close" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestIds\": [\n \"\",\n \"\"\n ],\n \"message\": \"The IdentityNow Administrator manually closed this request.\",\n \"executionStatus\": \"Terminated\",\n \"completionStatus\": \"Failure\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "access-request-config", + "description": "", + "item": [ + { + "id": "874b5816-34cf-4984-bba5-0af9fd5df82c", + "name": "Get Access Request Configuration", + "request": { + "name": "Get Access Request Configuration", + "description": { + "content": "This endpoint returns the current access-request configuration.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "bb2e5b16-d79e-4676-8c27-fae9941796f6", + "name": "Access Request Configuration Details.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4b824e5c-4c37-467a-88ff-4ea52e1dae77", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "93ddcad3-164a-460e-b0a3-4a5a7911d8e3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "80262551-cf43-48d5-8f2e-b28ec2b5435d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ac3b6a2e-0d09-442c-86da-e647f8e7cfe6", + "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": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7cf5d1f6-d121-4f23-b2c2-8f6d39b7855f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8b901e48-79b2-4020-8573-edbc051a02c7", + "name": "Update Access Request Configuration", + "request": { + "name": "Update Access Request Configuration", + "description": { + "content": "This endpoint replaces the current access-request configuration.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b6baa554-bb5f-474d-a427-a959bcfc13eb", + "name": "Access Request Configuration Details.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2f144c0-aeb7-4ca2-8013-a87e1f900ac3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "715e5d5c-cef3-4a0a-8558-a94ebc438f3e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "05893fb5-fe21-43af-93e0-324891eb8635", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d0cbf01-5e52-46f6-87fa-81c4a06788ed", + "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": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5469dff1-c35d-4c40-84f8-6fd4711f344b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "access-request-status", + "description": "", + "item": [ + { + "id": "c3a0bde4-7691-459e-92fd-47d2bda2ac4a", + "name": "Access Request Status", + "request": { + "name": "Access Request Status", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "b9319317-d3ef-4869-ae4d-f7152f54a934", + "name": "List of requested item status.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n ],\n \"state\": \"PROVISIONING_FAILED\",\n \"approvalDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"CANCELLED\",\n \"scheme\": \"APP_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"PENDING\",\n \"scheme\": \"ACCESS_PROFILE_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"CANCELLED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ]\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"CANCELLED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n }\n ]\n }\n ],\n \"accountActivityItemId\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"modified\": \"\",\n \"created\": \"\",\n \"requester\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"proidente0\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"\",\n \"reviewer\": \"\",\n \"decision\": \"APPROVED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"COMPLETED\",\n \"result\": \"FAILED\",\n \"phaseReference\": \"\"\n },\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"CANCELLED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n }\n ],\n \"description\": \"\",\n \"removeDate\": \"\",\n \"cancelable\": \"\",\n \"accessRequestId\": \"\",\n \"clientMetadata\": {\n \"veniam_91f\": \"\",\n \"magna_d_\": \"\",\n \"consequat95\": \"\",\n \"sint_cc\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"cancelledRequestDetails\": {\n \"comment\": \"\",\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n ],\n \"state\": \"NOT_ALL_ITEMS_PROVISIONED\",\n \"approvalDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"CANCELLED\",\n \"scheme\": \"ENTITLEMENT_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"CANCELLED\",\n \"scheme\": \"MANAGER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"EXPIRED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ]\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"CANCELLED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n }\n ]\n }\n ],\n \"accountActivityItemId\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"modified\": \"\",\n \"created\": \"\",\n \"requester\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"sodViolationContext\": {\n \"state\": \"ERROR\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"minima\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"\",\n \"reviewer\": \"\",\n \"decision\": \"APPROVED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"EXECUTING\",\n \"result\": \"FAILED\",\n \"phaseReference\": \"\"\n },\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"PENDING\",\n \"result\": \"FAILED\",\n \"phaseReference\": \"\"\n }\n ],\n \"description\": \"\",\n \"removeDate\": \"\",\n \"cancelable\": \"\",\n \"accessRequestId\": \"\",\n \"clientMetadata\": {\n \"et_4\": \"\",\n \"ullamco_3\": \"\",\n \"eu_4e6\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "743336f5-1b6b-4c0a-915f-0c83edfa6790", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49c41e90-e77c-4b3b-b754-7e737ec67799", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b46c3bad-beb7-4aaf-88bc-2fd4c51736f6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "641d280e-d19d-4d5b-a23e-d31c6c331dad", + "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": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13e62a04-d43a-4096-a463-3dd430727486", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "access-request-approvals", + "description": "", + "item": [ + { + "name": "pending", + "description": "", + "item": [ + { + "id": "134b5590-8860-407a-80c0-1371b3e82ce9", + "name": "Pending Access Request Approvals List", + "request": { + "name": "Pending Access Request Approvals List", + "description": { + "content": "This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "7c007600-621b-41a0-aeaa-2b9e797f4e01", + "name": "List of Pending Approvals.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"actionInProcess\": \"FORWARDED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"commodo23\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"actionInProcess\": \"REJECTED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"quis_17\": \"\",\n \"dolorc1\": \"\",\n \"id10\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f3d0d5f-5d77-4e2d-98b9-78090fb14106", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a7724ff2-2449-4f58-831b-65ad1c8f1e3c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e70f553-74a9-46e6-804e-49045381e3c6", + "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": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d39a19b2-630b-4527-97f0-11a28a0a69da", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "completed", + "description": "", + "item": [ + { + "id": "a3022cc8-c85b-4a95-903a-f696fc674b21", + "name": "Completed Access Request Approvals List", + "request": { + "name": "Completed Access Request Approvals List", + "description": { + "content": "This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6740266b-fb43-418f-950d-e1219f91a8aa", + "name": "List of Completed Approvals.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"reviewerComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"state\": \"APPROVED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"ERROR\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"exercitation_b\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ENTITLEMENT\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"reviewerComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"state\": \"REJECTED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"sunt3\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efd96ef8-7ba4-4e8b-8c6c-b8b50c08e739", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "096350d9-2656-46cf-8277-b7e6d8fc068d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ad757c6-728c-4aac-acbb-d0f4f0599152", + "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": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4a5c4a4-ab88-43e2-a8a1-d2e8cd77213b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{approvalId}", + "description": "", + "item": [ + { + "name": "approve", + "description": "", + "item": [ + { + "id": "5160d838-edfc-4745-8449-39182d2d1b3a", + "name": "Approves an access request approval.", + "request": { + "name": "Approves an access request approval.", + "description": { + "content": "This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "approvalId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6953dc66-b48c-4e57-bcc1-9607814dd3a9", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "060272cf-0d87-4eec-81bb-4879cd11e8fe", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fc656f07-2af1-4c93-bcf6-440502140dfb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f136351a-ec1d-415c-a185-f0a695897114", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dba5a724-88e2-4f78-aee1-509a6f6db438", + "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": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c363b384-5a5b-469b-9b0a-02cf21b5dc4d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reject", + "description": "", + "item": [ + { + "id": "648e9cc8-58d6-4a9d-b2c8-b6e00e6843b0", + "name": "Rejects an access request approval.", + "request": { + "name": "Rejects an access request approval.", + "description": { + "content": "This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "approvalId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f5a67e19-ee5e-41ec-a7e3-288cff83cf5a", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a52aedaa-027c-47b1-bb46-c410e23f6091", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "19518193-40f8-4734-814c-03b0158f33d8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4386c55d-ca05-45b8-a4ab-53cce79ac9fc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20b7b1cd-6176-4767-b34f-8576f57de47f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ce4cb4e9-a0c9-47aa-8386-792c7a20e9fe", + "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": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eab43d81-b413-4c3c-9abd-542f43367e7e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "forward", + "description": "", + "item": [ + { + "id": "99212e71-e67b-4a63-ab00-07114a0577ca", + "name": "Forwards an access request approval to a new owner.", + "request": { + "name": "Forwards an access request approval to a new owner.", + "description": { + "content": "This endpoint forwards an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "approvalId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e6a55060-edbf-4d1b-a0d7-5e7a68ea559c", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c19ed90a-3d4f-443f-8c01-9cc39d79b8ad", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2259a0d-d128-4871-9471-57e86e04aa3d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f29217a4-033a-492b-8b4b-9dda45c7d388", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57066e68-8174-44e9-821b-da18daa5ec9b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8332be56-212a-4a5a-8895-81913a93e6f6", + "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": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5e1c03c9-f9ff-47e4-9c29-cc1230d7ec72", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "approval-summary", + "description": "", + "item": [ + { + "id": "70682ec4-be45-45a0-a4df-7c76bb1f28e3", + "name": "Get the number of pending, approved and rejected access requests approvals", + "request": { + "name": "Get the number of pending, approved and rejected access requests approvals", + "description": { + "content": "This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "0d84cef1-de98-4908-9c06-c6cbea28db7f", + "name": "Number of pending, approved, rejected access request approvals.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"pending\": \"\",\n \"approved\": \"\",\n \"rejected\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "de6966c7-2653-4ee4-8e37-c27375d2da9e", + "name": "Client Error - Returned if the query parameter is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65b83124-b264-40ef-b7d2-876f8f8bbd22", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bd74412e-43b4-435e-9551-1b7a6f1a582b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ab47a2f-50e8-4481-89bc-600e3979744e", + "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": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5b322d0-995d-45f8-b943-d838a6970724", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "ai-access-request-recommendations", + "description": "", + "item": [ + { + "id": "1bb09b77-d632-4e27-8611-f01bc86e66ff", + "name": "Identity Access Request Recommendations", + "request": { + "name": "Identity Access Request Recommendations", + "description": { + "content": "This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "ai-access-request-recommendations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Get access request recommendations for an identityId. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "me" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "15" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "If *true* it will populate a list of translation messages in the response.", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, access.type**\n\nBy default the recommendations are sorted by highest confidence first.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "53826a3c-b9ba-4c14-8041-d063becb4e3e", + "name": "List of access request recommendations for the identityId", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Get access request recommendations for an identityId. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "me" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "15" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "If *true* it will populate a list of translation messages in the response.", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, access.type**\n\nBy default the recommendations are sorted by highest confidence first.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"ignored\": \"\",\n \"requested\": \"\",\n \"viewed\": \"\",\n \"messages\": [\n {\n \"interpretation\": \"\"\n },\n {\n \"interpretation\": \"\"\n }\n ],\n \"translationMessages\": [\n {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"ignored\": \"\",\n \"requested\": \"\",\n \"viewed\": \"\",\n \"messages\": [\n {\n \"interpretation\": \"\"\n },\n {\n \"interpretation\": \"\"\n }\n ],\n \"translationMessages\": [\n {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4637b10-96e8-4e2a-a2d8-0d27c12ec97d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Get access request recommendations for an identityId. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "me" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "15" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "If *true* it will populate a list of translation messages in the response.", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, access.type**\n\nBy default the recommendations are sorted by highest confidence first.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74306e21-c0f4-46f2-95f1-6d5c2effbe52", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Get access request recommendations for an identityId. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "me" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "15" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "If *true* it will populate a list of translation messages in the response.", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, access.type**\n\nBy default the recommendations are sorted by highest confidence first.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11809d44-c5ba-4154-b782-c961e8169bf6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Get access request recommendations for an identityId. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "me" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "15" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "If *true* it will populate a list of translation messages in the response.", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, access.type**\n\nBy default the recommendations are sorted by highest confidence first.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f40a61f1-eec8-444c-8e3d-82ba99a7755f", + "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": { + "url": { + "path": [ + "ai-access-request-recommendations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Get access request recommendations for an identityId. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "me" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "15" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "If *true* it will populate a list of translation messages in the response.", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, access.type**\n\nBy default the recommendations are sorted by highest confidence first.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "972e3709-7247-40a6-bf1c-3e4e8782a2d3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Get access request recommendations for an identityId. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "me" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "15" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "If *true* it will populate a list of translation messages in the response.", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, access.type**\n\nBy default the recommendations are sorted by highest confidence first.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "ignored-items", + "description": "", + "item": [ + { + "id": "704151cf-3e7f-48d0-8f56-ec7172b0b735", + "name": "Notification of Ignored Access Request Recommendations", + "request": { + "name": "Notification of Ignored Access Request Recommendations", + "description": { + "content": "This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "54884a89-f9de-4905-940e-bd54c979fb9a", + "name": "Recommendation successfully stored as ignored.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35b55123-6cd7-47f8-a20d-1310f0342446", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "054f7d95-7216-4725-895c-b913292cf580", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2f2abbc8-4b2c-451f-8fe7-6f26dee06af3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b919439a-6a54-43ee-ab9c-1d6ae5edc3d9", + "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": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e01cd543-70e1-4ef5-9d07-9c2c22b2fc90", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a5d53502-c68a-45a3-a468-0408d50c17ec", + "name": "List of Ignored Access Request Recommendations", + "request": { + "name": "List of Ignored Access Request Recommendations", + "description": { + "content": "This API returns the list of ignored access request recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "afdf492d-f94a-44c3-b46a-fd99a9067ee1", + "name": "Returns list of ignored access request recommendations.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "791e9b51-1935-4d61-9e14-e6a3b6c465eb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6dee884a-6d8e-4c9b-87d3-bf0e6c74c106", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7f6a1978-01f7-4bcd-939c-1ecb0ef76340", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5eac55b3-5b47-4b4f-b542-21afe0997ad5", + "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": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "465a489a-5aba-4662-ac53-4a07523103f8", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "ignored-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "requested-items", + "description": "", + "item": [ + { + "id": "ed6a7dfd-79c1-45ad-b121-1082d5d29e82", + "name": "Notification of Requested Access Request Recommendations", + "request": { + "name": "Notification of Requested Access Request Recommendations", + "description": { + "content": "This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "130c77c2-081b-45dd-a29b-709708ed938b", + "name": "Notification successfully acknowledged.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bb554ef0-5ce4-4c47-bc00-a73ffabf83c7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4fdef2bc-4981-4010-883d-66f305ab9d4c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c36550c0-4789-49b4-803b-824a8c3d9da6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a792bee3-f06b-40fb-949e-524dbd63fe17", + "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": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "934edefb-2a5c-48b2-b2c4-a9b0ab30061d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "990eaa91-66da-42ff-bb71-eec98d3141a3", + "name": "List of Requested Access Request Recommendations", + "request": { + "name": "List of Requested Access Request Recommendations", + "description": { + "content": "This API returns a list of requested access request recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3da958d0-ca19-493d-a75e-6d5f78adb437", + "name": "Returns the list of requested access request recommendations.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c34cdea1-92ae-4d50-9add-c3140ebe810e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a2782ee-c895-45e7-a56c-05f29b96c17c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab494b2f-cbaf-428c-9469-0b48ea4805c0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0917b78d-6fb4-4c13-80a3-9daa715180f6", + "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": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef94d57c-958c-427b-b709-0e0fb7caf1bf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "requested-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "viewed-items", + "description": "", + "item": [ + { + "id": "059a5d88-d081-4f75-9a20-ef22a0719a0e", + "name": "Notification of Viewed Access Request Recommendations", + "request": { + "name": "Notification of Viewed Access Request Recommendations", + "description": { + "content": "This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7a59241a-7d82-4789-bbcb-4857726922a7", + "name": "Recommendation successfully stored as viewed.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "77ad7979-1821-4705-af40-9fded43405b0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb0e6f0c-7ff7-4cf2-a868-2f132f99f230", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0b166ff-d1de-463d-add2-87d7072a9e00", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f7f7ee40-c07e-4c9b-a899-79fa8cb45794", + "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": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74d2ce4b-4e85-4f03-970a-2cc84bebc0b5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d3fc1af4-9bed-4f5a-b221-2be5b151a9ac", + "name": "List of Viewed Access Request Recommendations", + "request": { + "name": "List of Viewed Access Request Recommendations", + "description": { + "content": "This API returns the list of viewed access request recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c13e6f09-9979-4805-89b7-93f533086f80", + "name": "Returns list of viewed access request recommendations.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "854bd100-4a27-49fd-86bf-654cdeecbb8b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5a465a4-4367-4f54-93f2-a526ad2f9682", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95855965-aeb0-438c-8f01-abcafd5e67e9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db3f59a3-1dad-4616-8be3-d18af998d33f", + "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": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98fce8fe-0c76-4d5b-b8eb-0c2bb8fc2146", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter recommendations 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**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.id, access.type, identityId, timestamp**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "bulk-create", + "description": "", + "item": [ + { + "id": "8c9f18b6-d8bd-4977-9dd1-017f84fff887", + "name": "Notification of Viewed Access Request Recommendations in Bulk", + "request": { + "name": "Notification of Viewed Access Request Recommendations in Bulk", + "description": { + "content": "This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items", + "bulk-create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "650bca7e-360e-4b3f-b378-31273595f191", + "name": "Recommendations successfully stored as viewed.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items", + "bulk-create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d1c7a5a-3c33-4ac6-978a-4d527fdc3e94", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items", + "bulk-create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6372ca5d-d3ed-4f83-bda3-81f291b02115", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items", + "bulk-create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e48bb099-bc9b-4956-8efc-374fb2588bfc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items", + "bulk-create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d761c087-fdd9-48e7-b3c5-b16131fae867", + "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": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items", + "bulk-create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81a22cab-1067-40c0-9cde-0beba6268a82", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "ai-access-request-recommendations", + "viewed-items", + "bulk-create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n },\n {\n \"identityId\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "accounts", + "description": "", + "item": [ + { + "id": "90709be4-023c-4df9-82fb-f86547f6acb3", + "name": "Accounts List", + "request": { + "name": "Accounts List", + "description": { + "content": "This returns a list of accounts. \nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.", + "type": "text/plain" + }, + "key": "detailLevel", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f32e4d8c-9c09-40b5-a5d5-b8c27e5f3bff", + "name": "List of account objects", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.", + "type": "text/plain" + }, + "key": "detailLevel", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"uuid\": \"\",\n \"nativeIdentity\": \"\",\n \"description\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"hasEntitlements\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"identityId\": \"\",\n \"attributes\": {\n \"Excepteure0b\": 50459731.527163446,\n \"et040\": 99668701.97845608\n }\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"uuid\": \"\",\n \"nativeIdentity\": \"\",\n \"description\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"hasEntitlements\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"identityId\": \"\",\n \"attributes\": {\n \"Ut4c\": 68772382\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01cd26f5-8649-4798-872c-e6ddbb3919b8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.", + "type": "text/plain" + }, + "key": "detailLevel", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "666a0887-bdb6-417f-b11e-c30f223ff67e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.", + "type": "text/plain" + }, + "key": "detailLevel", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db57ad1d-ca67-4588-95f5-d3fb5c8c00b6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.", + "type": "text/plain" + }, + "key": "detailLevel", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1c96855-46d6-4f66-8233-1b3dd63853fd", + "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": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.", + "type": "text/plain" + }, + "key": "detailLevel", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "71454d00-af15-4fd3-ab2d-3d8622515505", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.", + "type": "text/plain" + }, + "key": "detailLevel", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b0aeb973-62ca-487d-8012-d9794b9a486c", + "name": "Create Account", + "request": { + "name": "Create Account", + "description": { + "content": "This API submits an account creation task and returns the task ID. \nThe `sourceId` where this account will be created must be included in the `attributes` object.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8b264854-7635-45e8-ab7d-9b3c75af472f", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8440e247-fcfd-490a-b0a1-1515989409f8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9740be6-9a07-4b7a-b8db-71ff3e1fc839", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1ada987d-d50e-4055-9824-180fa0b96ef6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d6644e7b-a077-4e69-bdd1-e956a4d9a01f", + "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": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3d5cbc82-4cec-47a1-8091-7bef77ddb2ff", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "91e1d1b5-4e1b-4b8f-aa6d-78049989fb29", + "name": "Account Details", + "request": { + "name": "Account Details", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d0101992-f7d8-4351-bbda-e663fca9efe0", + "name": "An account object", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"temporb5e\": true\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a0cc61c0-7c1d-4aa3-9782-037e02b7fa90", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef464459-d956-4a68-8d93-f50fbd82036c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e248725d-13d6-4ab7-a366-ba237c378bc9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a46ede18-bb6e-49d1-af8f-62d1a654842c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cde7f401-5fea-4393-b8ec-2bdeba13661e", + "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": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8eb4cb97-7c59-4ee8-ada8-1ad592831244", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ccc05bdc-2a10-4f4e-aa7e-a36521d37304", + "name": "Update Account", + "request": { + "name": "Update Account", + "description": { + "content": "This updates account details. \nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1089f80e-6814-4933-a8e9-840820ebc6c5", + "name": "Accepted. Update request accepted and is in progress.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f58fc0c0-8bfa-4c10-a23c-a90326a7802f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a8708ac7-6632-49e2-b9bd-0c5c06d0cc1a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1399f294-96d4-4a9b-9052-b1fa5070c6a6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f32b5e2b-8e0e-4bc1-906d-e17f0fe53028", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96a9214b-a671-48f4-a684-9216d77dcc09", + "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": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "71143f1d-fc1a-4c02-9762-b8a8b54ef09f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "bda6b2b2-e1d8-47b3-85b2-e725a585d7fb", + "name": "Update Account", + "request": { + "name": "Update Account", + "description": { + "content": "This API submits an account update task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f3f13bad-2ae3-49cb-ae43-3b1632ba6ab4", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7388c621-23fa-4616-a42b-1e9dba37f5ca", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b362ebe-333c-4e69-8a41-18416c6aaf12", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11dde977-d772-4475-9cc6-18dcbfcf16f4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "353ce9f3-bca5-4c86-982b-8eb4a9581541", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "02eaa67e-5773-453f-bb68-597e118dcb9e", + "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": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "60b02cc9-5b74-4210-92ec-10e81ffe8ce6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "7f54d15e-b06f-4c04-bc41-82e35c34606d", + "name": "Delete Account", + "request": { + "name": "Delete Account", + "description": { + "content": "This API submits an account delete task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "df9aafdc-be57-4520-8de7-fce43374f4bd", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d48d88eb-8ef8-4a75-badf-e67b94dca768", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1ef81e0-a8e8-46c5-8e53-1c9f90cd7f03", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c214636e-15b3-42c8-bc06-c11bf9e6e5bb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81eafda4-3179-4c65-b0c3-af5f0f1b26b2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "468c3b31-f25a-4604-ae7e-04fe4951262b", + "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": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "56effa9a-510f-40f9-a757-96d6fd189b99", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "entitlements", + "description": "", + "item": [ + { + "id": "5afb600b-936a-4d26-8ffe-c1860f850e7b", + "name": "Account Entitlements", + "request": { + "name": "Account Entitlements", + "description": { + "content": "This API returns entitlements of the account. \nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "7ab9130d-fdb4-4d22-86ca-e19768482ce6", + "name": "An array of account entitlements", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"dolore_40\": \"tempor Lorem dolor\",\n \"aute_e\": -44486449.80083678,\n \"est0\": -34337841.86800324\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"ex41\": false,\n \"ut_3\": false,\n \"veniam_3\": \"est minim consectetur\",\n \"aute32\": 15334616.312678099\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa2e7074-9235-4b77-b5bd-c8023d8e3b98", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "05d29dfb-6963-499a-adfc-06acc6fba038", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a90804ed-5fbc-482b-8513-6fe571738616", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5410f7ed-706b-41d2-8fa2-37dc061b8a59", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f33b015b-8e42-4424-9159-f8f96b56d12c", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "956ee48b-78ec-4c1c-8178-4bd6fdef0c44", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reload", + "description": "", + "item": [ + { + "id": "242b22f1-1a98-49c0-9c95-ed4608faef53", + "name": "Reload Account", + "request": { + "name": "Reload Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "1f8dfd6b-7879-4486-bc4c-57a89502026b", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4c299d9-9c23-408e-b038-f0de10d3a3c5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "798a68fc-016a-40cc-a3fc-b4f4faf721d4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7c30abd1-fc7b-43af-a700-2f6bc88f8f93", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49ce78d1-5d83-4ce6-a7d3-4e287aa09123", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ac6677c-932e-4e3b-b326-da69efa106ff", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b54e737b-a0fb-451a-b5bd-2cda87aff836", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "enable", + "description": "", + "item": [ + { + "id": "7cd17af7-c171-42eb-b31a-953ec6c2d18e", + "name": "Enable Account", + "request": { + "name": "Enable Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b663f164-becd-4a7b-91f2-4e81003d145c", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "25a9fc59-f7ff-41a0-b8fc-8916f7299a16", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e81468b-4e75-4982-b501-6314925ecb0b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30fcebab-2744-4b32-a3ba-d79ef148b32d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5f3694ec-38c7-4407-8314-f2956120b933", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3aefd71c-fd20-4e2a-bbd5-6a2b627e3990", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "792fca2b-487d-4cd9-87c3-6282f7b3dde0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "disable", + "description": "", + "item": [ + { + "id": "ed2a03d9-7fee-41ab-9718-2f2aed152be6", + "name": "Disable Account", + "request": { + "name": "Disable Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "98886db4-fcee-4254-a342-4719933566f0", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "09709754-5843-41d2-adab-a61e0ca90e52", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c833a64-9c24-4ee8-8649-38bf8a485847", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7240237-fe05-4430-a56e-8aea321606c7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bc66dcf9-f21b-4669-a7f6-76da57b75da8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6aa330a-8543-409b-9fbf-68bec00e6c66", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "503aaab0-ebd9-4dc2-beb6-0c1dc7c3a40c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "unlock", + "description": "", + "item": [ + { + "id": "7d6f293d-cfae-44bc-b7f9-f18840161cd9", + "name": "Unlock Account", + "request": { + "name": "Unlock Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d9bbb800-5072-4d53-b896-cfea3d2815ce", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65caa4b1-b2de-4494-acbf-962d3ad5db20", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0000312c-1ba1-42d4-a9d3-8fa09f58b5ec", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ce1921c7-b2ce-40d1-821c-8f014b55886a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d0fcb819-7a76-48b4-b813-408aae375639", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ad67550-0a15-4fe1-88ff-16a0b4678882", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5837619-8609-4f47-ba60-d6b1b915b01f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "search-attribute-config", + "description": "", + "item": [ + { + "id": "ae39437a-7ba5-42bb-8df2-19ccea41cc6b", + "name": "Configure/create extended search attributes in IdentityNow.", + "request": { + "name": "Configure/create extended search attributes in IdentityNow.", + "description": { + "content": "This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "5ee4fd30-25ce-4624-8c09-76162723fd49", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9bb0f3e-4361-4de0-a9b7-e3499b65bec8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b7a7b3cc-3621-4c67-8cbb-d6e279f029ce", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d3eef52-1fe3-4b1f-8a3a-32d0a7bb55cc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b636053-d11e-42d7-b270-b9e27a571a30", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "505a9a3a-7859-4e83-aac7-dbb48aa55fd0", + "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": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2f5dcb62-dd08-4100-abe4-eaa978926e08", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0e2e23b1-a5a1-4d5c-ab8c-b03386a402be", + "name": "Retrieve a list of extended search attributes in IdentityNow.", + "request": { + "name": "Retrieve a list of extended search attributes in IdentityNow.", + "description": { + "content": "This API retrieves a list of attribute/application associates currently configured in IdentityNow.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5f03276e-5326-43d9-802a-b01e0d80c875", + "name": "List of attribute configurations in IdentityNow.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a61881bc-0b3b-4f48-9b9a-39bfb0d2bd9e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e807a54c-46fa-4552-ba92-0f24c8dc9843", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b161a678-48c3-4b90-898e-ce991a144cda", + "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": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f19bf28-4fc0-4311-9988-96b6aa44a630", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{name}", + "description": "", + "item": [ + { + "id": "9ccfc344-772d-4021-b908-4bcc65e1ecad", + "name": "Get the details of a specific extended search attribute in IdentityNow.", + "request": { + "name": "Get the details of a specific extended search attribute in IdentityNow.", + "description": { + "content": "This API accepts an extended attribute name and retrieves the corresponding extended attribute configuration.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "name", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f9b47bf6-8b11-4ec6-93fb-ec644bd8582d", + "name": "Specific attribute configuration in IdentityNow.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4ded9e93-7db6-4867-a149-84c0f15ec471", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "89c56339-6f7d-4864-96e2-37e8ad6585e2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b950e08a-3734-4bb6-9272-56882d15da2a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74930b2a-4903-4d11-a3e5-2154e7202397", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa7de318-1845-44bb-ac7d-e2ef61f1b1a9", + "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": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f301f0bf-d144-4c68-8940-9e4467a85d8c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "57a75118-53a1-4154-8597-dc2d49698eae", + "name": "Delete an extended search attribute in IdentityNow.", + "request": { + "name": "Delete an extended search attribute in IdentityNow.", + "description": { + "content": "This API accepts an extended attribute name and deletes the corresponding extended attribute configuration.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "name", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "4c0884b1-1448-4d15-9bd6-4904f95428f7", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "11152d71-99b0-4b87-a0eb-6ebe37a559d7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb4410eb-0a60-403f-b7b3-ce1a32c127ff", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "93bc5200-a1b0-46c2-9fe6-d0e3bc073f46", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4df90470-c4cc-4c50-9a89-915e2596b90a", + "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": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5eddc26f-3a0a-415e-a79d-27a688fb2c7d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2e3286de-d4d3-457b-80ee-d68acc69c859", + "name": "Update the details of a specific extended search attribute in IdentityNow.", + "request": { + "name": "Update the details of a specific extended search attribute in IdentityNow.", + "description": { + "content": "This API updates an existing Search Attribute Configuration. The following fields are patchable:\n**name**, **displayName**, **applicationAttributes**\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "name", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "62482a06-ddf3-45e5-a0a2-5dba307cccf8", + "name": "Responds with the Search Attribute Configuration as updated.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"applicationAttributes\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e8d3a6e5-61a2-40db-bab7-93df37938314", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "abffa7ce-3e7b-4653-9682-1971eb04c3b4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "616096a2-0926-47c6-8e48-19837c311328", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "446516b9-b6d6-491b-9d1b-f9e0b9f4e5bc", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "06a441da-30bb-4a4d-b8bd-9e336be45791", + "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": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbc88291-1c88-4477-8cb8-99362c6bebf7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + "search-attribute-config", + ":name" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "identities-accounts", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "name": "enable", + "description": "", + "item": [ + { + "id": "38cf094d-a339-43bb-855a-1a008ddd9c75", + "name": "Enable IDN Account for Identity", + "request": { + "name": "Enable IDN Account for Identity", + "description": { + "content": "This API submits a task to enable IDN account for a single identity.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities-accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "fd2b846f-c1b1-443e-a3ea-5531689e2c20", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a57c5042-c95f-450f-a26f-55c7fe95313a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b45bd09e-2b01-43aa-8093-ce4bf2021bc0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "006ce245-9173-4323-b766-1593a24fafbc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0291dbcd-aa82-4817-bc72-21ea65c258ab", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "606f0e5b-0004-4aa1-867f-9b1f1ee0a6ab", + "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": { + "url": { + "path": [ + "identities-accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bd828d4-7373-4a00-a17c-27864b688370", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "disable", + "description": "", + "item": [ + { + "id": "8bcc33d7-a591-4b96-bfe7-2eb40af7076c", + "name": "Disable IDN Account for Identity", + "request": { + "name": "Disable IDN Account for Identity", + "description": { + "content": "This API submits a task to disable IDN account for a single identity.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities-accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "b8fb9642-b243-442a-b91f-a3b80d38dbef", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "762d8b93-7cda-445e-a5d6-514333da1597", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5bb65aeb-eb9a-414b-96d1-7c6edea07b23", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5500a7c-c43f-435c-9e53-42b8ff92794a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eec17ccd-2f3e-4163-835a-c336a0238b18", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e7f0d54c-ded1-4ecf-a3d6-c7169472b9e1", + "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": { + "url": { + "path": [ + "identities-accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e8495001-e538-479a-a761-5763e29a6f22", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "enable", + "description": "", + "item": [ + { + "id": "f964deed-a90f-48bf-a3d0-984dc2b45263", + "name": "Enable IDN Accounts for Identities", + "request": { + "name": "Enable IDN Accounts for Identities", + "description": { + "content": "This API submits tasks to enable IDN account for each identity provided in the request body.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities-accounts", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "201457e9-a4f7-4d21-9fb5-f9e95bc207e3", + "name": "Bulk response details.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Multi-Status (WebDAV) (RFC 4918)", + "code": 207, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"statusCode\": \"\",\n \"message\": \"\"\n },\n {\n \"id\": \"\",\n \"statusCode\": \"\",\n \"message\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01b724c6-a63b-4b45-8aa8-64be87b6b4e1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e23e335-e35d-4529-b464-4518faf71feb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff8fe39a-1b50-40f2-8847-9636bb0b8a63", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3cb7cafc-36ba-44f2-afcf-584ab581de70", + "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": { + "url": { + "path": [ + "identities-accounts", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3bd52c64-1d11-4fdf-845b-21861cc43e86", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "disable", + "description": "", + "item": [ + { + "id": "0591665e-bffc-466e-b3c6-08add1af0e7b", + "name": "Disable IDN Accounts for Identities", + "request": { + "name": "Disable IDN Accounts for Identities", + "description": { + "content": "This API submits tasks to disable IDN account for each identity provided in the request body.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities-accounts", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e385eb33-3720-4338-8c27-068e8310c61e", + "name": "Bulk response details.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Multi-Status (WebDAV) (RFC 4918)", + "code": 207, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"statusCode\": \"\",\n \"message\": \"\"\n },\n {\n \"id\": \"\",\n \"statusCode\": \"\",\n \"message\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a44fd5e-b828-4b4e-b44a-1ffa8b71295d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "52b8b5ab-7146-4988-bdfb-ae9b810a1cf3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bef00a2-4cf6-4f4d-a4e3-90631abbe8f9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7c831e0e-f78b-4c81-a6aa-887226fd47ef", + "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": { + "url": { + "path": [ + "identities-accounts", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4b44229-f6ec-411f-9690-7e3ff5c68a78", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities-accounts", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "account-activities", + "description": "", + "item": [ + { + "id": "9876b01a-9c27-42ce-8e4d-438e34ade11f", + "name": "List Account Activities", + "request": { + "name": "List Account Activities", + "description": { + "content": "This gets a collection of account activities that satisfy the given query parameters.", + "type": "text/plain" + }, + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The type of account activity.", + "type": "text/plain" + }, + "key": "type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "dff11f9f-8141-4278-819d-455c1181bfb4", + "name": "List of account activities", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The type of account activity.", + "type": "text/plain" + }, + "key": "type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"INCOMPLETE\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"FINISHED\",\n \"provisioningStatus\": \"PENDING\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"ENABLE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"tempor_69c\": \"\",\n \"ut39\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"FINISHED\",\n \"provisioningStatus\": \"COMMITED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"MODIFY\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"sunt_36\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"VERIFYING\",\n \"clientMetadata\": {\n \"voluptate_09c\": \"\",\n \"dolorb84\": \"\"\n },\n \"cancelable\": \"\",\n \"cancelComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"FAILURE\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"provisioningStatus\": \"RETRY\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"DELETE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"nostrudd_e\": \"\",\n \"elit_e8\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"provisioningStatus\": \"PENDING\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"ENABLE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"culpa_06\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"VERIFYING\",\n \"clientMetadata\": {\n \"qui_53b\": \"\",\n \"sint_6\": \"\"\n },\n \"cancelable\": \"\",\n \"cancelComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d5c84fe-7c19-4251-8e98-fd0785c950cd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The type of account activity.", + "type": "text/plain" + }, + "key": "type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "71fc28e5-770d-48f1-9bbb-17db7e7399ea", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The type of account activity.", + "type": "text/plain" + }, + "key": "type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3a18c263-2509-4045-a70f-76130fe76f49", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The type of account activity.", + "type": "text/plain" + }, + "key": "type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9cbc6103-fef6-4e85-aada-385a574bc645", + "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": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The type of account activity.", + "type": "text/plain" + }, + "key": "type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7a79da70-2f6e-40ff-b7fa-ecf3e952c95f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The type of account activity.", + "type": "text/plain" + }, + "key": "type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "4def9607-8e6c-4104-bfff-f32f6e294aef", + "name": "Get Account Activity", + "request": { + "name": "Get Account Activity", + "description": { + "content": "This gets a single account activity by its id.", + "type": "text/plain" + }, + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "937931a1-6fdb-45a5-8a97-6e3512b5b534", + "name": "An account activity object", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"FAILURE\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"RETURNED\",\n \"provisioningStatus\": \"UNVERIFIABLE\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"MODIFY\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"dolore_4\": \"\",\n \"consectetur_3\": \"\",\n \"dolor_c\": \"\",\n \"velit_dc\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"provisioningStatus\": \"RETRY\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"DELETE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"ina80\": \"\",\n \"consectetur_d\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"EXECUTING\",\n \"clientMetadata\": {\n \"pariatur0\": \"\",\n \"consequat36\": \"\"\n },\n \"cancelable\": \"\",\n \"cancelComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cdec9294-8c7f-493a-b1d4-076feebd8373", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7340e6ca-8a52-46bd-8b60-e481e089337d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ba209986-f020-456d-afff-9298b8e44194", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38f71c26-5a7e-4487-b254-48dfa33f0ac9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "900f14a2-670c-46aa-812c-21e6aa657927", + "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": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f722ed61-eadf-405a-bbeb-fc777326bd42", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "account-aggregations", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "name": "status", + "description": "", + "item": [ + { + "id": "4d7ce954-fff4-4ab0-afb4-95734e9c1a4c", + "name": "In-progress Account Aggregation status", + "request": { + "name": "In-progress Account Aggregation status", + "description": { + "content": "This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.\n\nAccounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.\n\nSince this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint.\n\n*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.*\n\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "account-aggregations", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "0664e878-b1aa-44a4-a39c-d9b9e161d49c", + "name": "An account aggregation status object", + "originalRequest": { + "url": { + "path": [ + "account-aggregations", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"start\": \"\",\n \"status\": \"RETRIED\",\n \"totalAccounts\": \"\",\n \"processedAccounts\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32c691c3-c747-41c8-8f6d-8f03914ecbf2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "account-aggregations", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb81044d-9b57-4972-8b5d-80be68a30885", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "account-aggregations", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e5040cb-2bec-4cf8-87d5-a88e70e2ad60", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "account-aggregations", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c45f5d36-5fa7-4fbd-b58c-b2a5fe587566", + "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": { + "url": { + "path": [ + "account-aggregations", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b2aa7f7-c524-40b8-b171-3f2733d2f8a2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "account-aggregations", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "campaigns", + "description": "", + "item": [ + { + "id": "8e30a92e-ee94-4cba-acc8-376b7d3f8558", + "name": "List Campaigns", + "request": { + "name": "List Campaigns", + "description": { + "content": "Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5a09ed8f-3ef8-4c3a-b66c-b5be9303151b", + "name": "A list of campaign objects.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"PENDING\",\n \"correlatedStatus\": \"CORRELATED\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5438859-fefb-40f1-aa42-ea2dafb624d4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "908bc512-e2cf-4a89-8b78-84e4e9a137e3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca8ab890-cdde-4795-99a8-745b77ac1143", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2582a68d-bb4e-48a1-8338-8dc1896ff84c", + "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": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36cbd5d8-5255-4321-8193-083b860117d8", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "FULL" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8730f2eb-9073-4b75-9669-fb0948ba38c0", + "name": "Create a campaign", + "request": { + "name": "Create a campaign", + "description": { + "content": "Creates a new Certification Campaign with the information provided in the request body.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d8b2c676-579e-4908-9658-72ad5db51c08", + "name": "Indicates that the campaign requested was successfully created and returns its representation.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db0595b8-273c-4b2f-91fa-f2620d367a00", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db8be95e-b99c-47c7-b708-5acc9749f095", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "409302be-9022-443d-865f-2eeb73c851be", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "18090d2f-ee2a-4d8b-b9ea-d5502f5d68c7", + "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": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a19c28f2-09b3-4ca1-b14a-12b1340557ac", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "delete", + "description": "", + "item": [ + { + "id": "f21d92d9-4487-48ae-892a-e72bc46d6b3f", + "name": "Deletes Campaigns", + "request": { + "name": "Deletes Campaigns", + "description": { + "content": "Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "70318fc5-e770-4d58-9742-40d5b8d0b514", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d46f6a88-b66e-47a3-9fcd-4ee506238dc4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "029f2d0d-30ed-4ba0-8dfa-f273dc4be305", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "268e7412-40f2-4e53-8fb3-9e0143e73351", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df3ceb36-b07e-4be4-aaea-dd923c1af706", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b2824ca-dc64-4580-8bf3-65b5148ec5cb", + "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": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "21e0095a-91e9-445d-b47c-6839dafc50ad", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "f166c880-e599-4bc0-a1a3-6839acd1ec92", + "name": "Get a campaign", + "request": { + "name": "Get a campaign", + "description": { + "content": "Retrieves information for an existing campaign using the campaign's ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f0513541-76ba-41bf-bee5-6f9b70d554c0", + "name": "A campaign object", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE_COMPOSITION\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ARCHIVED\",\n \"correlatedStatus\": \"UNCORRELATED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1b055a3-b7d0-4878-bdec-559d0ccda2ff", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec8479cb-2c02-4a4a-b5d8-3c33ae2ab7fc", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a763b63b-3b97-464e-855b-20357a89aa60", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "765ee336-8ca4-455e-8286-2066cdf5cf63", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cb0013b-9517-4aa1-baf0-79d2d8bf6850", + "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": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "91e8dcfb-b8f9-41cb-9c56-bd478597b21b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "fcd4f008-2350-4ec7-bd02-9714d623028d", + "name": "Update a Campaign", + "request": { + "name": "Update a Campaign", + "description": { + "content": "Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8f424507-0327-4c52-9de3-3d078a1b8982", + "name": "Indicates the PATCH operation succeeded, and returns the campaign's new representation.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE_COMPOSITION\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ARCHIVED\",\n \"correlatedStatus\": \"UNCORRELATED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9cfa2771-6e58-4e71-9a39-015249227da3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b5bd212d-e495-478f-a602-1ae8bdde1aa8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f8a5e75-be1e-4713-9542-34e3aa217118", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48ee0774-2412-4408-88d0-8795a073be39", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e77213b7-ab6a-4b1d-97c7-5aa789091a1c", + "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": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "91ad71cb-1974-41f3-a0be-b29e5e4d93db", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "activate", + "description": "", + "item": [ + { + "id": "e062989c-816c-4ca0-9487-ada036645c80", + "name": "Activate a Campaign", + "request": { + "name": "Activate a Campaign", + "description": { + "content": "Submits a job to activate the campaign with the given Id. The campaign must be staged.\nRequires roles of CERT_ADMIN and ORG_ADMIN", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "cc062a5c-6e8f-4708-b570-48e31930ef5c", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef8622d6-f7c4-4ec0-b631-2a140c518299", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26b6011b-23fc-468a-bf9c-2b73fc7de5bc", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31cd223c-c580-40b3-92dc-3f150cc673f0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4808874d-6407-4b3d-9dfc-259768e40cef", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed02f905-b1f4-4e71-91e0-0f8362b9ca76", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b7b8b99-804f-4844-b157-eb03cfb34844", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "complete", + "description": "", + "item": [ + { + "id": "5983d04a-28a6-4480-8e36-fa38d7f381aa", + "name": "Complete a Campaign", + "request": { + "name": "Complete a Campaign", + "description": { + "content": ":::caution\n\nThis endpoint will run successfully for any campaigns that are **past due**.\n\nThis endpoint will return a content error if the campaign is **not past due**.\n\n:::\n\nCompletes a certification campaign. This is provided to admins so that they\ncan complete a certification even if all items have not been completed.\n\nRequires roles of CERT_ADMIN and ORG_ADMIN\n", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "eab16c19-01e7-4fc6-85f1-7931fffa9f57", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4263f0c-070f-4860-bdfd-6f14f79ee610", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecd4f75c-ae88-4f2f-9006-0b56a84712c7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "59c09352-33a8-4629-b466-b404467f9e67", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bc4ba523-9183-4b98-8fa1-16679ec733ed", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65b83dbf-b886-4223-b9c3-146b35a434e8", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "712ffa32-a963-4bc2-ad64-4fb6fc679298", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "run-remediation-scan", + "description": "", + "item": [ + { + "id": "7cc805d4-b7d5-446a-8b2f-7da3c5505482", + "name": "Run Campaign Remediation Scan", + "request": { + "name": "Run Campaign Remediation Scan", + "description": { + "content": "Kicks off remediation scan task for a certification campaign.\nRequires roles of CERT_ADMIN and ORG_ADMIN", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "run-remediation-scan" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "02f01e56-3807-4610-b770-942a0c679700", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-remediation-scan" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4ccdc48d-6f23-4dad-a369-a4b1d55da7ab", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-remediation-scan" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aebf8a12-5978-45bf-8db3-076974abffc3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-remediation-scan" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cf31bd1-4683-4548-88af-80cf8f774e9e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-remediation-scan" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8cf03e73-d6e5-432e-94c9-65d3b0116fe9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-remediation-scan" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9df765e6-eedc-4cdc-ac99-94b3498d7e4b", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "run-remediation-scan" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7216776b-c412-4e62-98c6-0c17b975bde0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-remediation-scan" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reassign", + "description": "", + "item": [ + { + "id": "06e5e363-24bc-490a-841f-984046657441", + "name": "Reassign Certifications", + "request": { + "name": "Reassign Certifications", + "description": { + "content": "This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "99824424-7f8d-4f60-8eea-39f136bf1df2", + "name": "The reassign task that has been submitted.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"FINISH_CERTIFICATION\",\n \"targetType\": \"CAMPAIGN\",\n \"targetId\": \"\",\n \"status\": \"ERROR\",\n \"errors\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa241f52-dbc0-47a3-b29e-3ec7b18add69", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c4a387a-68fe-42d5-9a94-d06524f8d6a1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "37e5dd86-afe8-4f7e-98ed-076a4a894aff", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9a42318-c4d9-4861-93e0-01f60bb2cdb8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b47b547-455a-40f5-a784-88447eff345a", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "80981e12-cc17-434e-bccb-77a2251a3c07", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reports", + "description": "", + "item": [ + { + "id": "a8cc1e25-b284-4359-bd88-f8a4a7b5c233", + "name": "Get Campaign Reports", + "request": { + "name": "Get Campaign Reports", + "description": { + "content": "Fetches all reports for a certification campaign by campaign ID.\nRequires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c0e864f3-8019-4aef-87b4-93b347da9145", + "name": "Array of campaign report objects.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"reportType\": \"CAMPAIGN_COMPOSITION_REPORT\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"ERROR\",\n \"lastRunAt\": \"\"\n },\n {\n \"reportType\": \"CAMPAIGN_REMEDIATION_STATUS_REPORT\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PENDING\",\n \"lastRunAt\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e147a72-6c9b-4984-90c0-91de43efef4b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bcdffb88-952c-41d9-9c93-eeb9c51fd80f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae1bee9a-2f81-4fe0-80c2-a9088ca70424", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa3e4c08-c674-4a47-bf92-9c088c4e1742", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2bd52f5f-178f-4f51-ba36-184f9c717067", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24c58487-97e6-4ecc-802d-5b27eb8d11b0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "run-report", + "description": "", + "item": [ + { + "name": "{type}", + "description": "", + "item": [ + { + "id": "a02f340b-5147-4fb3-85db-885154d2a607", + "name": "Run Campaign Report", + "request": { + "name": "Run Campaign Report", + "description": { + "content": "Runs a report for a certification campaign.\nRequires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "CERTIFICATION_SIGNOFF_REPORT", + "key": "type", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "3c2c9c35-0811-4134-b2e7-94b84f7a8af3", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "109494a5-7e07-47d0-9a3a-4bb68154f7a4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d94016ec-bf42-494c-9a1d-52cd4d534719", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9756532d-f49d-4246-aa49-8d5a3fb6388d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9e0ab0c1-1820-459c-b02b-3098468d6c87", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a15d0c1-a2e9-4e25-a163-86d1fca6b88d", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9892fd5-177e-4a66-8efe-c9ab09211588", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "reports-configuration", + "description": "", + "item": [ + { + "id": "cd4431d6-83c1-4662-9b9e-72c86c301620", + "name": "Get Campaign Reports Configuration", + "request": { + "name": "Get Campaign Reports Configuration", + "description": { + "content": "Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns.\nRequires roles of CERT_ADMIN and ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d8d30b0b-cf6c-4549-b527-0d487a9be03a", + "name": "Campaign Report Configuration", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4712a8dc-afd0-45a4-b901-5c55c32f6889", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4fef607d-09ad-493d-8236-445cac90c709", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "235ffeb3-8af5-453b-9754-44c747b9c3b9", + "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": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ee6200e5-55be-4f96-afb8-95e262b97640", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "253593e7-0664-4bac-89a9-b33f092f887d", + "name": "Set Campaign Reports Configuration", + "request": { + "name": "Set Campaign Reports Configuration", + "description": { + "content": "Overwrites configuration for campaign reports.\nRequires roles CERT_ADMIN and ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "144f6dff-a6e7-4391-bb57-a13c790de4ea", + "name": "The persisted Campaign Report Configuration", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26543ce0-30ae-4f4f-9b22-74ce9c32be77", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49bc4785-ea34-4081-992c-03fbd21eaa15", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4288a75c-ce4c-42d2-87de-998a4a7c3f9a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6ad4209-1684-43b0-8105-7b5c7c8d4ac5", + "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": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c9de1e5-8f08-48f6-b6d6-20b8002a0791", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "reports-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identityAttributeColumns\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "campaign-templates", + "description": "", + "item": [ + { + "id": "55847142-e92a-4c8a-a97a-e0171f263ef8", + "name": "List Campaign Templates", + "request": { + "name": "List Campaign Templates", + "description": {}, + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **name, id**", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "41a2f94e-5d36-4ac5-a99d-cd2c788b626d", + "name": "List of campaign template objects", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **name, id**", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"STAGED\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"MANAGER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ERROR\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"RULE\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ROLE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ce8810c-6284-4688-9e84-8c613a5ba86f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **name, id**", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33beac7d-e084-4a7d-a091-3a0458eb94d7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **name, id**", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98d3e63f-50d8-4140-a83b-1a039e81b74e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **name, id**", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e05a425d-5802-4f6c-bff4-d55128577dce", + "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": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **name, id**", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "034931ca-1af4-44a1-821f-1439e4efa310", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **name, id**", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a7cf2fc5-9cc1-4f13-af7a-a6f9f555e85c", + "name": "Create a Campaign Template", + "request": { + "name": "Create a Campaign Template", + "description": {}, + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6930173d-8bbe-4b60-a521-2e5e1de605ba", + "name": "Created successfully.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c023c9fc-dee3-4cff-995b-627317337f7e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "158331bb-e3b4-4b4f-a7a0-ddbbc80c4ac2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff8eee52-a019-4986-8006-f2da5405030b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c61029f7-96b7-4f7a-9721-a8af5a22e0bb", + "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": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "29a0e313-1de9-485b-a98b-483c47984009", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "eaf78f9a-11ad-4b3f-afeb-1a53ef59aab5", + "name": "Get a Campaign Template", + "request": { + "name": "Get a Campaign Template", + "description": { + "content": "Fetches a campaign template by ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "68cb12b1-fc59-4a7d-85c0-4f355e0f86ed", + "name": "The data for the campaign matching the given ID.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc5b58aa-39f8-4b66-877e-a259ad088431", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "573f3e5c-f471-4349-ae41-6d9e585cdb7b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9be7f360-5ca1-4f31-b3dd-623f52fe6aa1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dad4e1aa-80ef-4793-a884-00a9c13cd0f4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa28a0b3-2fe2-4294-b7c2-f2b598f2b7db", + "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": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a61f040-7544-460f-bf49-871de684195c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "73d514e5-6d91-480f-9e1b-3f62d03fbd70", + "name": "Update a Campaign Template", + "request": { + "name": "Update a Campaign Template", + "description": { + "content": "Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "84e56128-7f27-4604-8f94-516312637fec", + "name": "Indicates the PATCH operation succeeded, and returns the template's new representation.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"campaign\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ACTIVATING\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"IDENTITY\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"WARN\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"REVOKE_ONLY_DECISIONS\"\n },\n \"id\": \"\",\n \"scheduled\": \"\",\n \"ownerRef\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"deadlineDuration\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "276160f9-8a99-4494-a3b0-ab6dd68c2b7c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b002f831-ad11-41cc-a2d8-3e175ca08d7b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "80d29fae-0bd9-49ec-8bdb-3618886a3482", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "976a28d0-a782-4584-ade0-b943114d0547", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "376c8e93-9d71-47be-b9fb-f4fa4d7ce177", + "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": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e72f75a-a148-4568-97ba-fd189368c635", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5b8c5170-7935-4a84-918f-65c1753f3a2e", + "name": "Delete a Campaign Template", + "request": { + "name": "Delete a Campaign Template", + "description": { + "content": "Deletes a campaign template by ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "722586a2-728e-4a4e-8480-c30d99de5016", + "name": "The Source was successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "012e0cfd-f40d-4e2b-8b71-da94c1925cd8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e82132fe-56e3-40ff-b024-bf87baf5df2d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb5b3faf-60f3-4e22-aa6e-cbda7f8db934", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45b72430-36f8-4b5e-9780-1c09ca61addd", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6bbe1bb-c7e2-4df9-a6f1-3ceddea228d5", + "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": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b7326887-a59d-4875-9e7b-f2d30913685c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "generate", + "description": "", + "item": [ + { + "id": "55ae1551-4f5a-4aef-adc7-e60b04f34fd6", + "name": "Generate a Campaign from Template", + "request": { + "name": "Generate a Campaign from Template", + "description": { + "content": "Generates a new campaign from a campaign template.\nThe campaign object contained in the template has special formatting applied to its name and description fields in order to determine the generated campaign's name/description. Placeholders in those fields are formatted with the current date and time upon generation.\nPlaceholders consist of a percent sign followed by a letter indicating what should be inserted; for example, \"%Y\" will insert the current year; a campaign template named \"Campaign for %y\" would generate a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020).\nValid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html).\nRequires roles ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaign-templates", + ":id", + "generate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "02ef2d78-9bbb-4d63-b9f4-b7fe6d9417fe", + "name": "Indicates a campaign was successfully generated from this template, and returns a reference to the new campaign.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "generate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"SOURCE_OWNER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a7386d8f-1043-45ce-bdd7-c62985de92ae", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "generate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d6c8344-4be0-47a5-944e-50a88c05ff3c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "generate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e220e05-21a6-467f-a4b1-0c019d996603", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "generate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f3c43057-dc15-4d54-a125-5b01b01363c9", + "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": { + "url": { + "path": [ + "campaign-templates", + ":id", + "generate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a1efb03-c6f1-407e-b690-cbdbb93be1d7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "generate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "schedule", + "description": "", + "item": [ + { + "id": "d29d369f-40c8-494a-8585-6e114fbd9e77", + "name": "Gets a Campaign Template's Schedule", + "request": { + "name": "Gets a Campaign Template's Schedule", + "description": { + "content": "Gets the schedule for a campaign template. Returns a 404 if there is no schedule set.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "fe33d715-ca6b-4633-a5e6-0d532db9bd44", + "name": "The current schedule for the campaign template. See the PUT endpoint documentation for more examples.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f134af3-74c0-4749-87fd-9c77847e65ab", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20e61142-a787-4ea7-bc3f-1956d1da9114", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0cac152-563f-4100-ba1b-3c95861f8218", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "092619f7-f094-4d2f-8908-c38681c5fd21", + "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": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "afcb10ed-4995-43cc-9b89-0fddc566f8a1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f2c68d47-097b-431b-a61e-60c0f0cd9c39", + "name": "Sets a Campaign Template's Schedule", + "request": { + "name": "Sets a Campaign Template's Schedule", + "description": { + "content": "Sets the schedule for a campaign template. If a schedule already exists, it will be overwritten with the new one.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "50115bd2-eeb3-427b-8737-71dbff956416", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "48530279-260f-4233-9622-dbeb611d38ca", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea5e7c37-31bb-40fc-b710-88121b7918d2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "081240fc-831e-4950-83bc-71a73362f5a7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df26dba5-4355-4810-bb96-3ea8e1d0b7a8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57710018-2744-405a-b09b-4d8125eedacc", + "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": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e9980e5-2c5b-473f-9705-92f3bb994656", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b2642453-64c5-4740-9a15-35bcce2e4d0c", + "name": "Deletes a Campaign Template's Schedule", + "request": { + "name": "Deletes a Campaign Template's Schedule", + "description": { + "content": "Deletes the schedule for a campaign template. Returns a 404 if there is no schedule set.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "e672ef77-6e04-4eed-a4de-92ed4b4400c2", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "99abd8da-1fa7-4e88-9490-ce237d45242f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "215482bd-e639-4097-a23e-5884c8fd160c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "52034a9b-fad6-4327-89c0-42f5ba720efa", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "feb9792b-44ba-44d8-b893-9f0bc0ee2f4e", + "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": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff07cce7-cf04-4576-971e-7d469000099e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaign-templates", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "certifications", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "name": "reassign-async", + "description": "", + "item": [ + { + "id": "9d622959-80ff-4bb4-8823-704f357621d0", + "name": "Reassign Certifications Asynchronously", + "request": { + "name": "Reassign Certifications Asynchronously", + "description": { + "content": "This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "reassign-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7e603c5f-4c96-4b22-bda8-638089c7efd7", + "name": "A certification task object for the reassignment which can be queried for status.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"certificationId\": \"\",\n \"type\": \"REASSIGN\",\n \"status\": \"QUEUED\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75545df2-4148-4364-85e7-dee41833075a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9be5f0be-6e50-4be1-9668-c975460b72f1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4075d618-80bc-48c7-847f-df72efeb3c1f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f7d21458-3b79-4433-8492-749792e531c3", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ce0d97a-528c-4f04-ba92-81a22fdd2825", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "reassign-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5bbbe1b4-2fe5-4886-960f-2c7e4f8df09f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY_SUMMARY\"\n },\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "tasks", + "description": "", + "item": [ + { + "name": "{taskId}", + "description": "", + "item": [ + { + "id": "62ed58d4-9425-44d1-adba-9a45840ffa91", + "name": "Certification Task Status", + "request": { + "name": "Certification Task Status", + "description": { + "content": "This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "tasks", + ":taskId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "taskId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8eab1981-5d57-48d3-b7f5-0fab2f13700f", + "name": "A certification task object.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks", + ":taskId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"certificationId\": \"\",\n \"type\": \"REASSIGN\",\n \"status\": \"QUEUED\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a47f1114-8c7e-4032-ba38-4d4514b7967b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks", + ":taskId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fab58fcb-f6ca-4564-987a-5336eda00508", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks", + ":taskId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f9c8247-c45d-4e96-9214-e0ca6c6728db", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks", + ":taskId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a656f26e-1164-43d7-a636-072f9cd7bf2b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks", + ":taskId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a9485386-71a6-4ada-a823-a12ba6f87025", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "tasks", + ":taskId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b64c055b-ea02-40dd-9a5e-51f0ec0e6e2b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks", + ":taskId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "tasks-pending", + "description": "", + "item": [ + { + "id": "3e39e4d7-6cb8-4f6a-bcc1-b65c464e22b0", + "name": "Pending Certification Tasks", + "request": { + "name": "Pending Certification Tasks", + "description": { + "content": "This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks 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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "tasks-pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5b36a1bd-1a1d-4ac8-a018-034adf16a584", + "name": "A list of pending (`QUEUED` or `IN_PROGRESS`) certification task objects.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks-pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"certificationId\": \"\",\n \"type\": \"REASSIGN\",\n \"status\": \"ERROR\",\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"certificationId\": \"\",\n \"type\": \"REASSIGN\",\n \"status\": \"SUCCESS\",\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a72b463-d93e-4e7c-b436-5fb7cc661571", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks-pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4db40e44-e340-485e-b33f-f0901afd82f1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks-pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b10153eb-4a9e-4003-8179-7a029089e792", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks-pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa0510d9-1d35-47a0-9cbc-42d102afa14c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks-pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf89dc6b-8a57-4d30-b0c2-898f2a0a4d41", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "tasks-pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b2a17c9-bfd8-44a5-b40b-d1f0c4a12620", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "tasks-pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reviewers", + "description": "", + "item": [ + { + "id": "8a52d399-99cf-451e-8017-77167811c661", + "name": "List of Reviewers for the certification", + "request": { + "name": "List of Reviewers for the certification", + "description": { + "content": "This API returns a list of reviewers for the 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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "reviewers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ede4a83e-3772-4b7e-b4a7-851eaedc7934", + "name": "A list of reviewers", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reviewers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6281a8d4-3a5f-4c7c-b119-a21d4b2ca686", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reviewers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5151a03d-0915-4303-9696-ebc106809de5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reviewers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d6e0717-9e90-42ad-a889-b1e6a160677e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reviewers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa06ba26-286e-4039-8850-95e7c78c50b4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reviewers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d63f8a2a-494a-471e-9ed3-f7057670c9d5", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "reviewers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73b4b55f-04a1-4561-bca8-d71ad003a140", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reviewers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "{certificationId}", + "description": "", + "item": [ + { + "name": "access-review-items", + "description": "", + "item": [ + { + "name": "{itemId}", + "description": "", + "item": [ + { + "name": "permissions", + "description": "", + "item": [ + { + "id": "e0db384a-120a-4ef6-b1a8-5ec3b3b2be90", + "name": "Permissions for Entitlement Certification Item", + "request": { + "name": "Permissions for Entitlement Certification Item", + "description": { + "content": "This API returns the permissions associated with an entitlement certification item based on the certification item's 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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":certificationId", + "access-review-items", + ":itemId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "certificationId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "itemId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "289f3e81-f954-4752-91ff-8ba45c1c9664", + "name": "A list of permissions associated with the given itemId", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":certificationId", + "access-review-items", + ":itemId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c8eae204-8dc5-438d-a6ae-4feee2aeb6c9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":certificationId", + "access-review-items", + ":itemId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1fb0e502-15c2-4e5f-946e-bd4160a72985", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":certificationId", + "access-review-items", + ":itemId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "049653a1-cc13-4184-9b8c-4d8d77c205d4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":certificationId", + "access-review-items", + ":itemId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62a9618e-e93e-4b7c-b370-e1719006b2a1", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":certificationId", + "access-review-items", + ":itemId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "deb2573e-6611-4f72-b2ab-ab89e4a5d1dc", + "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": { + "url": { + "path": [ + "certifications", + ":certificationId", + "access-review-items", + ":itemId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "944babb3-6c4e-454a-b3e7-3d6ab04f0767", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":certificationId", + "access-review-items", + ":itemId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "connector-rules", + "description": "", + "item": [ + { + "id": "473db1ad-0ef2-4190-8c91-a92018441e9e", + "name": "List Connector Rules", + "request": { + "name": "List Connector Rules", + "description": { + "content": "Returns the list of connector rules.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "31e5d33d-215b-41a7-b893-3e4b3d765932", + "name": "A list of connector rules", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"created\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrProvision\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {},\n \"modified\": \"\"\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"PeopleSoftHRMSBuildMap\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {},\n \"modified\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6203192c-e2b2-4c6e-a5f7-6620a28098a3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3f5911d-763a-416d-96bf-135e19a2d7b2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "76f00602-66c0-4715-8a46-c976420f86c2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c23261a-a638-4149-baf5-1fd2bf6a2b9b", + "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": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5604008e-d8fa-4541-b742-d7b761767d20", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "de2630f3-c78a-469b-80a4-b1e08bee0236", + "name": "Create Connector Rule", + "request": { + "name": "Create Connector Rule", + "description": { + "content": "Creates a new connector rule.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"WebServiceAfterOperationRule\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "024cd9ba-6e91-4bd5-ab91-9a5902861b3c", + "name": "The created connector rule", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"WebServiceAfterOperationRule\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"JDBCOperationProvisioning\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {},\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f1f61e1-3290-4943-996c-abc7d863aaa7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"WebServiceAfterOperationRule\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "25efd299-b418-430b-adb9-f91f49823680", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"WebServiceAfterOperationRule\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01a4ed0f-5e75-4a93-8017-f3ca40afff8d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"WebServiceAfterOperationRule\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0dc4201-189d-4882-9c62-20bdaa8ac8e7", + "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": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"WebServiceAfterOperationRule\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c78e8694-b23b-4525-a51a-c1fffa153642", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "connector-rules" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"WebServiceAfterOperationRule\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "01df8cf3-77be-404b-b08d-738de5506cd1", + "name": "Connector-Rule by ID", + "request": { + "name": "Connector-Rule by ID", + "description": { + "content": "Returns the connector rule specified by ID.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "2b54c9a9-0aa3-4192-bd4f-27c54409dc22", + "name": "Connector rule with the given ID", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"JDBCOperationProvisioning\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {},\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0058211d-ba45-4da7-875a-54c26a778c62", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "549a46a9-2039-486d-b360-21a0814236ad", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0c268f4-bef0-45d2-82c2-1dd8e045fb99", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3afd157-7155-4638-8d38-11e564b07cdf", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e6a59658-0943-4f6e-b19b-ec61b61cabff", + "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": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "79d96fc1-3750-489d-a589-08e20757dac0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0d3e0800-1564-424d-bbd0-f7766d9caf47", + "name": "Update a Connector Rule", + "request": { + "name": "Update a Connector Rule", + "description": { + "content": "Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrManagerRule\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3ff5237f-0c5a-4d44-8065-4ec8c7744f97", + "name": "The updated connector rule", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrManagerRule\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"JDBCOperationProvisioning\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {},\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fe241118-2a34-4216-83b9-85ae2723ae2d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrManagerRule\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "460315ce-ac43-44d0-96a6-540d7aeed4d3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrManagerRule\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1c3aa248-de56-43f2-a784-2936cb15eb70", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrManagerRule\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "142f90ca-3aff-44db-bb19-0d68f4ed6ca8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrManagerRule\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2bacc09-70c7-4c54-a4c5-1fcb4aa7b3be", + "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": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrManagerRule\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f37f6aa-01d2-41fa-ab65-be27b72b616b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"sourceCode\": {\n \"version\": \"\",\n \"script\": \"\"\n },\n \"type\": \"SapHrManagerRule\",\n \"description\": \"\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n ],\n \"output\": {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\"\n }\n },\n \"attributes\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "3511f320-3b9b-4215-9fd9-1c2a98956859", + "name": "Delete a Connector-Rule", + "request": { + "name": "Delete a Connector-Rule", + "description": { + "content": "Deletes the connector rule specified by the given ID.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "42cb711d-420c-4230-ba81-8505b478b65b", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "8ccbcd0b-97bd-4046-a11a-bb0f27a628ae", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa17589f-6072-4baf-abfa-5815fc73d9f5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb1d26a8-dc27-4985-9f30-2db4896b28e3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f760ffb-fc0e-45ca-9b77-05638e2a634b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4891c04e-fb67-403f-9503-b02979be0cc1", + "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": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51c706cc-437d-475f-b8df-4ca6fd2bbd6d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "validate", + "description": "", + "item": [ + { + "id": "30163da2-77a3-476c-bf06-20b87441bc60", + "name": "Validate Connector Rule", + "request": { + "name": "Validate Connector Rule", + "description": { + "content": "Returns a list of issues within the code to fix, if any.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "connector-rules", + "validate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"version\": \"\",\n \"script\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d55d14aa-9db3-4317-a3bb-e1bbb957b78a", + "name": "The status of the code's eligibility as a connector rule", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + "validate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"version\": \"\",\n \"script\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"state\": \"ERROR\",\n \"details\": [\n {\n \"line\": \"\",\n \"column\": \"\",\n \"messsage\": \"\"\n },\n {\n \"line\": \"\",\n \"column\": \"\",\n \"messsage\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "58a2d1ec-b3f9-4a10-9a6b-eb74bad3e919", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + "validate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"version\": \"\",\n \"script\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "adf95b17-0373-4708-aa66-b735bc2fb55a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + "validate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"version\": \"\",\n \"script\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0090bff6-3442-42ba-bd75-af452cc80d10", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + "validate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"version\": \"\",\n \"script\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1b1f3101-6ccd-4399-bf9e-e3334b767fad", + "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": { + "url": { + "path": [ + "connector-rules", + "validate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"version\": \"\",\n \"script\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4896b6fe-c571-4ea3-a2b0-abb8ca2104da", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "connector-rules", + "validate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"version\": \"\",\n \"script\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "connectors", + "description": "", + "item": [ + { + "id": "96610979-6041-42f3-a5b4-3a40ee410517", + "name": "Gets connector list", + "request": { + "name": "Gets connector list", + "description": { + "content": "Fetches list of connectors that have 'RELEASED' status using filtering and pagination.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "connectors" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "de" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3974c69e-94c7-448a-9850-ac6b680b3fab", + "name": "A Connector Dto object", + "originalRequest": { + "url": { + "path": [ + "connectors" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "de" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"type\": \"\",\n \"scriptName\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"directConnect\": false,\n \"connectorMetadata\": {},\n \"status\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"scriptName\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"directConnect\": false,\n \"connectorMetadata\": {},\n \"status\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "718d074f-e190-4bdc-816a-c717d2455b1b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "connectors" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "de" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96bd8073-d5d3-45d6-9ba3-cea06e2b636b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "connectors" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "de" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e2598f4-f324-4e12-be04-dd58d3421d74", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "connectors" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "de" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0070a6cd-9d6c-4c41-929e-d1832c338718", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "connectors" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "de" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e4b7576-584c-4d18-a5e1-f34839cfd5a3", + "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": { + "url": { + "path": [ + "connectors" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "de" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6194eca0-d145-47c0-8652-29c1e1cdacf5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "connectors" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "de" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "custom-password-instructions", + "description": "", + "item": [ + { + "id": "e741448a-d717-4c57-86f7-600fe467998a", + "name": "Create Custom Password Instructions", + "request": { + "name": "Create Custom Password Instructions", + "description": { + "content": "This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "custom-password-instructions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"pageId\": \"flow-selection:select\",\n \"pageContent\": \"\",\n \"locale\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ea07038c-ab50-4590-8eb2-ecf43128396e", + "name": "Reference to the custom password instructions.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"pageId\": \"flow-selection:select\",\n \"pageContent\": \"\",\n \"locale\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"pageId\": \"flow-selection:select\",\n \"pageContent\": \"\",\n \"locale\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4e7da03-de06-4629-a2f4-c08ad1d45aa4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"pageId\": \"flow-selection:select\",\n \"pageContent\": \"\",\n \"locale\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b9b787b-cd74-47c7-8fcb-8e201468d147", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"pageId\": \"flow-selection:select\",\n \"pageContent\": \"\",\n \"locale\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a6d8a95-b79e-4c9f-90c9-bff0543561c8", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"pageId\": \"flow-selection:select\",\n \"pageContent\": \"\",\n \"locale\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{pageId}", + "description": "", + "item": [ + { + "id": "bad9ae40-e880-4be6-9718-e077b1cef71d", + "name": "Get Custom Password Instructions by Page ID", + "request": { + "name": "Get Custom Password Instructions by Page ID", + "description": { + "content": "This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "unlock-account:enter-username", + "key": "pageId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8ae2262a-118b-4797-be86-585ef9ba97f9", + "name": "Reference to the custom password instructions.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"pageId\": \"flow-selection:select\",\n \"pageContent\": \"\",\n \"locale\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "37dae18d-1d59-48bc-a7cf-2e7e8b50be2a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "631d73f2-4d4b-49e5-96ac-ca35c3322b87", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51f50550-01b3-45b6-a9f7-d2a712aee03a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6286c0fe-3929-4d67-9f1d-1b2b38a063d6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9fb33219-aab3-4368-a79b-7247c639a501", + "name": "Delete Custom Password Instructions by page ID", + "request": { + "name": "Delete Custom Password Instructions by page ID", + "description": { + "content": "This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "unlock-account:enter-username", + "key": "pageId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "eb6fed27-9d13-4dd8-a496-1c3a80cd4011", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "ff91e944-9976-41b2-8ca2-0313a41363b1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b49431e2-e770-4cef-8db8-5bf62bb83971", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4011c58a-00f8-46c9-a19f-bccd5d67d2f7", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e937800-3c1e-4cd0-b754-0b7b8caf3eee", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "custom-password-instructions", + ":pageId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".", + "type": "text/plain" + }, + "key": "locale", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "entitlements", + "description": "", + "item": [ + { + "id": "aa2588d2-5a2e-4b88-8a6b-fd840b88a838", + "name": "Gets a list of entitlements.", + "request": { + "name": "Gets a list of entitlements.", + "description": { + "content": "This API returns a list of entitlements.\n\nThis API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive).\n\nAny authenticated token can call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).", + "type": "text/plain" + }, + "key": "account-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.", + "type": "text/plain" + }, + "key": "segmented-for-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "07d0c7b9-f5d0-4a98-871a-cee004f6191a", + "name": "List of entitlements", + "originalRequest": { + "url": { + "path": [ + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).", + "type": "text/plain" + }, + "key": "account-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.", + "type": "text/plain" + }, + "key": "segmented-for-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"dolore_40\": \"tempor Lorem dolor\",\n \"aute_e\": -44486449.80083678,\n \"est0\": -34337841.86800324\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"ex41\": false,\n \"ut_3\": false,\n \"veniam_3\": \"est minim consectetur\",\n \"aute32\": 15334616.312678099\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "819b0430-3cbb-42b3-8b85-8e9bf121de63", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).", + "type": "text/plain" + }, + "key": "account-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.", + "type": "text/plain" + }, + "key": "segmented-for-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "61f33b4c-7239-4a61-acc1-ce9ad7c73f32", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).", + "type": "text/plain" + }, + "key": "account-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.", + "type": "text/plain" + }, + "key": "segmented-for-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "862093ee-dc47-42c6-aee4-91afee996be8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).", + "type": "text/plain" + }, + "key": "account-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.", + "type": "text/plain" + }, + "key": "segmented-for-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "90fa263d-af12-44e3-b410-ac9ebd68ebdc", + "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": { + "url": { + "path": [ + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).", + "type": "text/plain" + }, + "key": "account-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.", + "type": "text/plain" + }, + "key": "segmented-for-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7986ef20-65c5-4351-82ca-3fbe13c36ffb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).", + "type": "text/plain" + }, + "key": "account-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.", + "type": "text/plain" + }, + "key": "segmented-for-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "d1574edd-476c-4785-acee-ea842d3dd8a4", + "name": "Get an entitlement", + "request": { + "name": "Get an entitlement", + "description": { + "content": "This API returns an entitlement by its ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ca3ac32e-afce-490b-8198-071075c9a618", + "name": "An entitlement", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"ut_83\": -74588029\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "54875558-e26c-4ba6-8b20-ed7f6c825371", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65e93a6d-7c08-4806-b18a-977b90aa6886", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f41ac3da-4652-4298-890c-bcb2a706eb4d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "264d95f0-a2cc-4f73-b9a6-53e769f95815", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a9506738-3637-477a-8da1-5046a9af42c2", + "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": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0edc7c98-b82c-4b63-9813-266f32d57d7b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c2b3d275-7f20-43bf-9b9c-ef26ed30a4e2", + "name": "Patch an entitlement", + "request": { + "name": "Patch an entitlement", + "description": { + "content": "This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**.\n\nWhen you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.\n\nA token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "074791ae-d2cd-4ab9-9b73-279c4d119df8", + "name": "Responds with the entitlement as updated.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"ut_83\": -74588029\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4cea3fe-239d-4746-a178-3663009f76e0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "de520391-92bc-4459-91f2-591094c61fad", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d23adaf5-1577-4f70-a7ae-7aaf307bf6ba", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d64eace9-3914-4e1e-bfe0-e6c7b33697aa", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb85f8d6-3bb1-4ef3-924a-71a72bdd1fa4", + "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": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "94170677-479b-4684-a640-417e9e4319d3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "parents", + "description": "", + "item": [ + { + "id": "10a834f8-b918-4c83-b264-99bfb71bc00b", + "name": "List of entitlements parents", + "request": { + "name": "List of entitlements parents", + "description": { + "content": "This API returns a list of all parent entitlements of a given entitlement.", + "type": "text/plain" + }, + "url": { + "path": [ + "entitlements", + ":id", + "parents" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3f6ce1e1-1949-4040-a829-daf9b654d834", + "name": "List of entitlements parents from an entitlement", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "parents" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"dolore_40\": \"tempor Lorem dolor\",\n \"aute_e\": -44486449.80083678,\n \"est0\": -34337841.86800324\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"ex41\": false,\n \"ut_3\": false,\n \"veniam_3\": \"est minim consectetur\",\n \"aute32\": 15334616.312678099\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5265c01-c7bc-44c2-a2a1-6a1f76b05982", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "parents" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9beaff18-985e-4bf2-83a1-aeddd18165e9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "parents" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "08091bbe-000a-4ce6-8f16-c1530a73f45b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "parents" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2be6af77-1caa-42a2-ba14-1b4774cb759f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "parents" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ce53220-94f3-4dad-9e90-19f9b0b7c98c", + "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": { + "url": { + "path": [ + "entitlements", + ":id", + "parents" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1193e3fb-1127-4179-9314-072166358004", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "parents" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "children", + "description": "", + "item": [ + { + "id": "7830c7f6-415a-4bac-aa3a-9c13effe2765", + "name": "List of entitlements children", + "request": { + "name": "List of entitlements children", + "description": { + "content": "This API returns a list of all child entitlements of a given entitlement.", + "type": "text/plain" + }, + "url": { + "path": [ + "entitlements", + ":id", + "children" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "56db72eb-1979-4470-bfc7-d9fe06c953ea", + "name": "List of entitlements children from an entitlement", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "children" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"dolore_40\": \"tempor Lorem dolor\",\n \"aute_e\": -44486449.80083678,\n \"est0\": -34337841.86800324\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"description\": \"\",\n \"requestable\": false,\n \"attributes\": {\n \"ex41\": false,\n \"ut_3\": false,\n \"veniam_3\": \"est minim consectetur\",\n \"aute32\": 15334616.312678099\n },\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ],\n \"segments\": [\n \"\",\n \"\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": false,\n \"DESCRIPTION\": false\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9174495b-e364-4b68-8836-6999c8c64d42", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "children" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "246e3f2e-984b-4de9-9e4d-9824580abad4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "children" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eff11fa6-90e7-4e41-8f81-c9ce335e770b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "children" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "72ed130a-d204-4115-adaf-633d1fd7952a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "children" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "717b6b57-94b0-49a7-8fd1-dc0cb347fb25", + "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": { + "url": { + "path": [ + "entitlements", + ":id", + "children" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "124211b6-d066-44d8-b61f-0adae78ebd5a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "children" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **id, name, created, modified, type, attribute, value, source.id**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "entitlement-request-config", + "description": "", + "item": [ + { + "id": "5bb12657-e2ad-4e78-a156-45746e693e15", + "name": "Get Entitlement Request Config", + "request": { + "name": "Get Entitlement Request Config", + "description": { + "content": "This API returns the entitlement request config for a specified entitlement.", + "type": "text/plain" + }, + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f4ae0e46-a271-4173-afcd-e08fea9c73d5", + "name": "An Entitlement Request Config", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efb51dbd-c341-43a1-8798-1f0e4a07bc00", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7f313078-997c-42a7-8794-4df8acd5a74c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a9cec9b5-1f48-41bb-9360-8c47c00266b7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "919b1bba-c95c-4061-9943-614c5eed05fe", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "053345b6-6b79-4a5c-af06-124e923550e1", + "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": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0606854d-f89f-4d17-8795-0858bd3a1fcf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "71a4c90a-23d9-48a6-ace2-6f286402e1e0", + "name": "Replace Entitlement Request Config", + "request": { + "name": "Replace Entitlement Request Config", + "description": { + "content": "This API replaces the entitlement request config for a specified entitlement.", + "type": "text/plain" + }, + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c5f560c0-3a0f-43c3-bb2a-bd1ea8f0f870", + "name": "Responds with the entitlement request config as updated.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e3c76d4-9c3a-47bc-8316-b2fb4c249fd8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38e4bf95-0b92-4675-9c3b-e8195c9ed7e1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "611d3ce8-f7b3-49d0-852b-9756cd47aa42", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1bb4e8bb-336a-47d4-9e5f-ab499cfdd1ce", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d193a54-622c-42a0-b35b-710c66f33653", + "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": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17a492c6-3079-42d8-be1f-63f32b7c88aa", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-update", + "description": "", + "item": [ + { + "id": "22c621e9-7975-4f34-b058-2cf7ed74e0ec", + "name": "Bulk update an entitlement list", + "request": { + "name": "Bulk update an entitlement list", + "description": { + "content": "This API applies an update to every entitlement of the list.\n\nThe number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : **{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }** \n\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "entitlements", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"jsonPatch\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d5dfa00e-ba15-4f78-86a0-8f38e3b0c14a", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"jsonPatch\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "52e069a2-7b59-4452-add2-5c26a2a01a6f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"jsonPatch\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b471db8-ae60-4f91-b817-fc966f1d9636", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"jsonPatch\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed3000cc-72e0-4b58-84be-22ecff9156f8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"jsonPatch\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "00b48f9b-2c9a-4b19-a591-7990e759a64c", + "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": { + "url": { + "path": [ + "entitlements", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"jsonPatch\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e3878f22-7638-4f81-94a9-256af7c727c0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "entitlements", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"jsonPatch\": [\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "generate-password-reset-token", + "description": "", + "item": [ + { + "name": "digit", + "description": "", + "item": [ + { + "id": "f70cc71f-93f7-4255-bfe3-a89cde08de00", + "name": "Generate a digit token", + "request": { + "name": "Generate a digit token", + "description": { + "content": "This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\".", + "type": "text/plain" + }, + "url": { + "path": [ + "generate-password-reset-token", + "digit" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"\",\n \"length\": \"\",\n \"durationMinutes\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "02ec25b8-911b-45f0-b9cb-5323da761ec1", + "name": "The digit token for password management.", + "originalRequest": { + "url": { + "path": [ + "generate-password-reset-token", + "digit" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"\",\n \"length\": \"\",\n \"durationMinutes\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"digitToken\": \"\",\n \"requestId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d6a8b9fe-67c0-4572-b7f1-ab3ede2c85b5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "generate-password-reset-token", + "digit" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"\",\n \"length\": \"\",\n \"durationMinutes\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "502949d9-8a18-4aae-986d-b7f0368bb5cf", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "generate-password-reset-token", + "digit" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"\",\n \"length\": \"\",\n \"durationMinutes\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab1fda3e-aca1-4303-b36f-33e6054dbbca", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "generate-password-reset-token", + "digit" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userId\": \"\",\n \"length\": \"\",\n \"durationMinutes\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "historical-identities", + "description": "", + "item": [ + { + "id": "f797d6bc-556d-4d36-ada2-692532423b12", + "name": "Lists all the identities", + "request": { + "name": "Lists all the identities", + "description": { + "content": "This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This param is used for starts-with search for first, last and display name of the identity", + "type": "text/plain" + }, + "key": "starts-with-query", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list down deleted identities or not.", + "type": "text/plain" + }, + "key": "is-deleted", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list active or inactive identities.", + "type": "text/plain" + }, + "key": "is-active", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6d570043-d795-47db-8ba0-cd00dc79ce8b", + "name": "List of identities for the customer.", + "originalRequest": { + "url": { + "path": [ + "historical-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This param is used for starts-with search for first, last and display name of the identity", + "type": "text/plain" + }, + "key": "starts-with-query", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list down deleted identities or not.", + "type": "text/plain" + }, + "key": "is-deleted", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list active or inactive identities.", + "type": "text/plain" + }, + "key": "is-active", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"active\": true,\n \"deletedDate\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"active\": true,\n \"deletedDate\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d7e69af-57fd-4814-a778-a1d5c5b02536", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This param is used for starts-with search for first, last and display name of the identity", + "type": "text/plain" + }, + "key": "starts-with-query", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list down deleted identities or not.", + "type": "text/plain" + }, + "key": "is-deleted", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list active or inactive identities.", + "type": "text/plain" + }, + "key": "is-active", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9c8bf73-e8e4-424b-b070-9c051988b2eb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This param is used for starts-with search for first, last and display name of the identity", + "type": "text/plain" + }, + "key": "starts-with-query", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list down deleted identities or not.", + "type": "text/plain" + }, + "key": "is-deleted", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list active or inactive identities.", + "type": "text/plain" + }, + "key": "is-active", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "22924086-8c48-46bf-b48d-dcd061aa104b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This param is used for starts-with search for first, last and display name of the identity", + "type": "text/plain" + }, + "key": "starts-with-query", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list down deleted identities or not.", + "type": "text/plain" + }, + "key": "is-deleted", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list active or inactive identities.", + "type": "text/plain" + }, + "key": "is-active", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "154fa974-6119-4f34-bfa5-fa1f329a0045", + "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": { + "url": { + "path": [ + "historical-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This param is used for starts-with search for first, last and display name of the identity", + "type": "text/plain" + }, + "key": "starts-with-query", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list down deleted identities or not.", + "type": "text/plain" + }, + "key": "is-deleted", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list active or inactive identities.", + "type": "text/plain" + }, + "key": "is-active", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c871d94d-18c2-44f4-a416-8b912d225f2e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This param is used for starts-with search for first, last and display name of the identity", + "type": "text/plain" + }, + "key": "starts-with-query", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list down deleted identities or not.", + "type": "text/plain" + }, + "key": "is-deleted", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Indicates if we want to only list active or inactive identities.", + "type": "text/plain" + }, + "key": "is-active", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e89ba806-f5fa-40c0-9b15-8df952c5fc17", + "name": "Get latest snapshot of identity", + "request": { + "name": "Get latest snapshot of identity", + "description": { + "content": "This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e97709b0-6f11-4859-9099-c0d278b28022", + "name": "The identity object.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"snapshot\": \"\",\n \"deletedDate\": \"\",\n \"accessItemCount\": {\n \"in_81\": \"\"\n },\n \"attributes\": {\n \"elit_ed\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f6de5c34-9798-418a-b37b-0ee33d72b8a8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b09b6eb-f540-4026-80e2-22f5b9adeac4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af9c31d9-045e-4fc9-b4d0-05b5a9240f23", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbbe8f71-eee6-47d0-9089-187490a2d3f7", + "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": { + "url": { + "path": [ + "historical-identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a7683d7-0c84-44a8-8a5e-df0d3c18c8a6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "access-items", + "description": "", + "item": [ + { + "id": "6f141afe-5586-4a9d-92dc-f75a468cf21c", + "name": "Gets a list of access items for the identity filtered by item type", + "request": { + "name": "Gets a list of access items for the identity filtered by item type", + "description": { + "content": "This method retrieves a list of access item for the identity filtered by the access item type Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The type of access item for the identity. If not provided, it defaults to account", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "70818329-c54d-42f1-ae67-362462628e32", + "name": "The list of access items.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The type of access item for the identity. If not provided, it defaults to account", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"accessType\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceName\": \"\",\n \"sourceId\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"entitlementCount\": \"\",\n \"appDisplayName\": \"\"\n },\n {\n \"accessType\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceName\": \"\",\n \"sourceId\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"entitlementCount\": \"\",\n \"appDisplayName\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a69c0cb3-69d7-4ba0-82cd-60603989b9a2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The type of access item for the identity. If not provided, it defaults to account", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b230fc87-7a09-48db-864f-9727c7d4d8d9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The type of access item for the identity. If not provided, it defaults to account", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7be05398-f8bd-4543-8fec-bf4682859e69", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The type of access item for the identity. If not provided, it defaults to account", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b13dc115-a12f-4515-ae6b-0db95af1bb0d", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The type of access item for the identity. If not provided, it defaults to account", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b9e2bbd-ea87-45ee-8f6e-59c9b852a228", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The type of access item for the identity. If not provided, it defaults to account", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "snapshots", + "description": "", + "item": [ + { + "id": "875e8378-30a4-4583-8d37-e249b4961498", + "name": "Lists all the snapshots for the identity", + "request": { + "name": "Lists all the snapshots for the identity", + "description": { + "content": "This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The specified start date", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating the range in day or month for the specified interval-name", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "cee746ca-c41b-49b1-849b-9519d0b32fd8", + "name": "A list of identity summary for each snapshot.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The specified start date", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating the range in day or month for the specified interval-name", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"snapshot\": \"\"\n },\n {\n \"snapshot\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fdecb0eb-411e-4b92-8e20-130bb8f97efe", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The specified start date", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating the range in day or month for the specified interval-name", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38e1f696-17a4-4fbc-996c-057d02a8b303", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The specified start date", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating the range in day or month for the specified interval-name", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3bc9a6b3-aaec-4830-996b-54f321c2dbd2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The specified start date", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating the range in day or month for the specified interval-name", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a4873447-fd0d-44a6-a995-9b6465562511", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The specified start date", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating the range in day or month for the specified interval-name", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "337f4210-da36-4c6e-bb3a-73405915ef5f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The specified start date", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating the range in day or month for the specified interval-name", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{date}", + "description": "", + "item": [ + { + "id": "c24b1b9e-1cb1-416d-a2a1-f2e9b53bc60c", + "name": "Gets an identity snapshot at a given date", + "request": { + "name": "Gets an identity snapshot at a given date", + "description": { + "content": "This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "date", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "79b2747e-ee36-450b-b214-1e322b070872", + "name": "The identity object.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"snapshot\": \"\",\n \"deletedDate\": \"\",\n \"accessItemCount\": {\n \"in_81\": \"\"\n },\n \"attributes\": {\n \"elit_ed\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f86d0fc6-f389-4a1c-9fb2-6a9dc6946f9e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3676b27e-629f-47e0-be92-873671e220f1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b1e4baf-59ef-4187-8f5a-4a7974cc157e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "307c1abc-2d24-4fc9-8611-82bdf1f62b90", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "46d37798-bfa7-428c-9ff0-e2392049cec1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "access-items", + "description": "", + "item": [ + { + "id": "f60088f2-4542-4035-a0dc-6c6ed1a27642", + "name": "Gets the list of identity access items at a given date filterd by item type", + "request": { + "name": "Gets the list of identity access items at a given date filterd by item type", + "description": { + "content": "This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The access item type", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "date", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d29fedb2-eb94-4d0d-b4f1-ae033911efb3", + "name": "The identity object.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The access item type", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"accessType\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceName\": \"\",\n \"sourceId\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"entitlementCount\": \"\",\n \"appDisplayName\": \"\"\n },\n {\n \"accessType\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceName\": \"\",\n \"sourceId\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"entitlementCount\": \"\",\n \"appDisplayName\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57c5ea48-78e1-48c1-b807-849c0f35f416", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The access item type", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13df799f-e489-4899-a410-e79614820489", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The access item type", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b95b3336-bd99-452f-a5c4-3841793a7e6d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The access item type", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "320b10ac-1ad2-46d4-b2a5-a61e2eb7abc2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The access item type", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e7a3bf7-e361-4629-91f3-75ce005f9b26", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshots", + ":date", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The access item type", + "type": "text/plain" + }, + "key": "type", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "snapshot-summary", + "description": "", + "item": [ + { + "id": "9ec856c4-391a-48d5-900d-c7862c15772e", + "name": "Gets the summary for the event count for a specific identity", + "request": { + "name": "Gets the summary for the event count for a specific identity", + "description": { + "content": "This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "snapshot-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The date before which snapshot summary is required", + "type": "text/plain" + }, + "key": "before", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating day or month. Defaults to month if not specified", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "The time zone. Defaults to UTC if not provided", + "type": "text/plain" + }, + "key": "time-zone", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "bf5f273d-e20b-406d-a4b3-c489226768e7", + "name": "A summary list of identity changes in date histogram format.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshot-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The date before which snapshot summary is required", + "type": "text/plain" + }, + "key": "before", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating day or month. Defaults to month if not specified", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "The time zone. Defaults to UTC if not provided", + "type": "text/plain" + }, + "key": "time-zone", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d0fb84b-ae6c-4e48-8429-c78c2f5540e7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshot-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The date before which snapshot summary is required", + "type": "text/plain" + }, + "key": "before", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating day or month. Defaults to month if not specified", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "The time zone. Defaults to UTC if not provided", + "type": "text/plain" + }, + "key": "time-zone", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17aeaf44-9bbd-4f0a-8173-99fa9122667c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshot-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The date before which snapshot summary is required", + "type": "text/plain" + }, + "key": "before", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating day or month. Defaults to month if not specified", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "The time zone. Defaults to UTC if not provided", + "type": "text/plain" + }, + "key": "time-zone", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aea0a7e9-e336-485e-9702-8801f8fb03ea", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshot-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The date before which snapshot summary is required", + "type": "text/plain" + }, + "key": "before", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating day or month. Defaults to month if not specified", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "The time zone. Defaults to UTC if not provided", + "type": "text/plain" + }, + "key": "time-zone", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e235f3c-884c-477f-a383-c4ac4e036f14", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshot-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The date before which snapshot summary is required", + "type": "text/plain" + }, + "key": "before", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating day or month. Defaults to month if not specified", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "The time zone. Defaults to UTC if not provided", + "type": "text/plain" + }, + "key": "time-zone", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0f56e8c5-640b-449e-afae-1298fa0f1dd9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "snapshot-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The date before which snapshot summary is required", + "type": "text/plain" + }, + "key": "before", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The interval indicating day or month. Defaults to month if not specified", + "type": "text/plain" + }, + "key": "interval", + "value": "day" + }, + { + "disabled": false, + "description": { + "content": "The time zone. Defaults to UTC if not provided", + "type": "text/plain" + }, + "key": "time-zone", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "events", + "description": "", + "item": [ + { + "id": "31b42b35-17ca-4418-8cfc-541695dfb0fe", + "name": "Lists all events for the given identity", + "request": { + "name": "Lists all events for the given identity", + "description": { + "content": "This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "events" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The optional instant from which to return the access events", + "type": "text/plain" + }, + "key": "from", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ae2cf459-c120-4cfe-bf64-56853f259805", + "name": "The list of events for the identity", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "events" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The optional instant from which to return the access events", + "type": "text/plain" + }, + "key": "from", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"accessItem\": {\n \"accessType\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceName\": \"\",\n \"sourceId\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"entitlementCount\": \"\",\n \"appDisplayName\": \"\"\n },\n \"identityId\": \"\",\n \"eventType\": \"\",\n \"dt\": \"\",\n \"governanceEvent\": {\n \"name\": \"\",\n \"dt\": \"\",\n \"type\": \"accessRequest\",\n \"governanceId\": \"\",\n \"owners\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ],\n \"reviewers\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ],\n \"decisionMaker\": {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n }\n },\n {\n \"accessItem\": {\n \"accessType\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"sourceName\": \"\",\n \"sourceId\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"entitlementCount\": \"\",\n \"appDisplayName\": \"\"\n },\n \"identityId\": \"\",\n \"eventType\": \"\",\n \"dt\": \"\",\n \"governanceEvent\": {\n \"name\": \"\",\n \"dt\": \"\",\n \"type\": \"accessRequest\",\n \"governanceId\": \"\",\n \"owners\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ],\n \"reviewers\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ],\n \"decisionMaker\": {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e7c2d13-bdaa-412e-97e8-172cbaa9bc17", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "events" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The optional instant from which to return the access events", + "type": "text/plain" + }, + "key": "from", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e34cd2b5-79fc-43cd-bd28-1c9dac817fd0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "events" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The optional instant from which to return the access events", + "type": "text/plain" + }, + "key": "from", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9bec4e41-a420-4e46-9cc0-5878c17f0137", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "events" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The optional instant from which to return the access events", + "type": "text/plain" + }, + "key": "from", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "08f812c6-ea4b-4d6c-9181-59641985c718", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "events" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The optional instant from which to return the access events", + "type": "text/plain" + }, + "key": "from", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "347cdd7a-aabd-4a9d-b7e7-5d61b28795a0", + "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": { + "url": { + "path": [ + "historical-identities", + ":id", + "events" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The optional instant from which to return the access events", + "type": "text/plain" + }, + "key": "from", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c08b316-2904-4ece-ac55-ed9557f3b775", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "events" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The optional instant from which to return the access events", + "type": "text/plain" + }, + "key": "from", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of event types to return. If null or empty, all events are returned", + "type": "text/plain" + }, + "key": "eventTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "start-date", + "description": "", + "item": [ + { + "id": "5ee51d0d-c9bf-423e-8441-b0b16c0f0648", + "name": "Gets the start date of the identity", + "request": { + "name": "Gets the start date of the identity", + "description": { + "content": "This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "start-date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1096f726-60e4-4ad7-9bfd-9eea94987941", + "name": "The start date of the identity", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "start-date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0069bb62-4f82-493c-97b7-1a316f3af4ce", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "start-date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "50d6aee9-7e38-4038-9cba-236f8be52fd5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "start-date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ce3ca845-b732-45ed-897e-e0cadfc465d2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "start-date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5fe981b-6c67-42a0-830a-9cd730ead929", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "start-date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34f2f9a5-64a0-48d1-8050-8cde68b696ba", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "start-date" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "compare", + "description": "", + "item": [ + { + "id": "35cc54e5-5717-4e16-8c0e-f4ab41ecaf9f", + "name": "Gets a difference of count for each access item types for the given identity between 2 snapshots", + "request": { + "name": "Gets a difference of count for each access item types for the given identity between 2 snapshots", + "description": { + "content": "This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "compare" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1ee549da-5c7f-4082-9d6c-3f9d28377611", + "name": "A IdentityCompare object with difference details for each access item type", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"accessItemDiff\": {\n \"consectetur_54\": {}\n }\n },\n {\n \"accessItemDiff\": {\n \"sint14a\": {},\n \"enim_18\": {},\n \"Excepteur_8c0\": {}\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8db9d9ef-a1a3-4429-a036-397b4de02648", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12d302a4-38b3-4253-9980-a00d08037f64", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65c846e6-69cd-483b-bde1-6be8b3813936", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fcd1a2d6-136f-49a0-807c-a606b8876453", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9864ad58-2923-48e1-b7af-429b00d2596d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ", + "type": "text/plain" + }, + "key": "accessItemTypes", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{access-type}", + "description": "", + "item": [ + { + "id": "e4e5fa8e-cf95-40fe-ad6e-4085186e3f50", + "name": "Gets a list of differences of specific accessType for the given identity between 2 snapshots", + "request": { + "name": "Gets a list of differences of specific accessType for the given identity between 2 snapshots", + "description": { + "content": "This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' ", + "type": "text/plain" + }, + "url": { + "path": [ + "historical-identities", + ":id", + "compare", + ":access-type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed", + "type": "text/plain" + }, + "key": "access-associated", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "key": "access-type" + }, + { + "disabled": false, + "description": { + "content": "(Required) The specific type which needs to be compared", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "accessType" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3b561119-cc5d-4e85-a0b8-e62ca9aa29c0", + "name": "A list of events for the identity", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare", + ":access-type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed", + "type": "text/plain" + }, + "key": "access-associated", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"eventType\": \"ADD\",\n \"displayName\": \"\",\n \"sourceName\": \"\"\n },\n {\n \"id\": \"\",\n \"eventType\": \"REMOVE\",\n \"displayName\": \"\",\n \"sourceName\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32376558-5f1c-4ea0-a72e-5a9364121804", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare", + ":access-type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed", + "type": "text/plain" + }, + "key": "access-associated", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e51bd190-6c00-44c6-96d5-8ca42a78ff61", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare", + ":access-type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed", + "type": "text/plain" + }, + "key": "access-associated", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "887fd1e6-e608-4cb3-9294-45b1e4484935", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare", + ":access-type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed", + "type": "text/plain" + }, + "key": "access-associated", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa86cd51-6bca-4092-992c-630c0eade5a4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare", + ":access-type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed", + "type": "text/plain" + }, + "key": "access-associated", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e5f3cf2-e986-46b0-a805-4ccac3e797df", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "historical-identities", + ":id", + "compare", + ":access-type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed", + "type": "text/plain" + }, + "key": "access-associated", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 1 of identity", + "type": "text/plain" + }, + "key": "snapshot1", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The snapshot 2 of identity", + "type": "text/plain" + }, + "key": "snapshot2", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "common-access", + "description": "", + "item": [ + { + "id": "ec22699b-c582-40d6-a291-33877a1da282", + "name": "Get a paginated list of common access", + "request": { + "name": "Get a paginated list of common access", + "description": { + "content": "This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read", + "type": "text/plain" + }, + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nFiltering is supported for the following fields and operators:\n\n**status**: *eq* \"CONFIRMED\" or \"DENIED\" **reviewedByUser** *eq* true or false **access.id**: *eq* \"id\" **access.type**: *eq* \"ROLE\" or \"ACCESS_PROFILE\" **access.name**: *sw* \"Administrator\" **access.description**: *sw* \"admin\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nSorting is supported for the following fields: **access.name,status**\n\nBy default the common access items are sorted by name, ascending.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "fa292adc-638b-476e-94f1-13c8050969ad", + "name": "Succeeded. Returns a list of common access for a customer.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nFiltering is supported for the following fields and operators:\n\n**status**: *eq* \"CONFIRMED\" or \"DENIED\" **reviewedByUser** *eq* true or false **access.id**: *eq* \"id\" **access.type**: *eq* \"ROLE\" or \"ACCESS_PROFILE\" **access.name**: *sw* \"Administrator\" **access.description**: *sw* \"admin\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nSorting is supported for the following fields: **access.name,status**\n\nBy default the common access items are sorted by name, ascending.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"\",\n \"lastUpdated\": \"\",\n \"reviewedByUser\": \"\",\n \"lastReviewed\": \"\"\n },\n {\n \"access\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"\",\n \"lastUpdated\": \"\",\n \"reviewedByUser\": \"\",\n \"lastReviewed\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da9c11a2-4af6-49b4-9032-ecb7912243fd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nFiltering is supported for the following fields and operators:\n\n**status**: *eq* \"CONFIRMED\" or \"DENIED\" **reviewedByUser** *eq* true or false **access.id**: *eq* \"id\" **access.type**: *eq* \"ROLE\" or \"ACCESS_PROFILE\" **access.name**: *sw* \"Administrator\" **access.description**: *sw* \"admin\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nSorting is supported for the following fields: **access.name,status**\n\nBy default the common access items are sorted by name, ascending.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4ca1c6f2-b963-433f-8ec2-13cd1566ca28", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nFiltering is supported for the following fields and operators:\n\n**status**: *eq* \"CONFIRMED\" or \"DENIED\" **reviewedByUser** *eq* true or false **access.id**: *eq* \"id\" **access.type**: *eq* \"ROLE\" or \"ACCESS_PROFILE\" **access.name**: *sw* \"Administrator\" **access.description**: *sw* \"admin\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nSorting is supported for the following fields: **access.name,status**\n\nBy default the common access items are sorted by name, ascending.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca3b8480-aad9-47c9-9b64-4bdd25fc3d20", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nFiltering is supported for the following fields and operators:\n\n**status**: *eq* \"CONFIRMED\" or \"DENIED\" **reviewedByUser** *eq* true or false **access.id**: *eq* \"id\" **access.type**: *eq* \"ROLE\" or \"ACCESS_PROFILE\" **access.name**: *sw* \"Administrator\" **access.description**: *sw* \"admin\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nSorting is supported for the following fields: **access.name,status**\n\nBy default the common access items are sorted by name, ascending.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "64d2b22b-d0ae-43ae-a8de-5a2d91169a92", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nFiltering is supported for the following fields and operators:\n\n**status**: *eq* \"CONFIRMED\" or \"DENIED\" **reviewedByUser** *eq* true or false **access.id**: *eq* \"id\" **access.type**: *eq* \"ROLE\" or \"ACCESS_PROFILE\" **access.name**: *sw* \"Administrator\" **access.description**: *sw* \"admin\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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)\n\nSorting is supported for the following fields: **access.name,status**\n\nBy default the common access items are sorted by name, ascending.", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "09d6e104-486e-4495-9cb0-2e70e74f2d9c", + "name": "Create common access items", + "request": { + "name": "Create common access items", + "description": { + "content": "This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create", + "type": "text/plain" + }, + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"DENIED\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7c39cd8c-2cfb-4651-8d37-bca7b05855da", + "name": "Returns details of the common access classification request.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"DENIED\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"CONFIRMED\",\n \"lastUpdated\": \"\",\n \"reviewedByUser\": \"\",\n \"lastReviewed\": \"\",\n \"createdByUser\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e993c046-6e81-4dbf-a824-5eb632afffb3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"DENIED\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6b3ad6e7-8750-4ddd-9b04-fd2b72a922cf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"DENIED\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e693b19e-dd67-484e-918f-70ffff809578", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"DENIED\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1ff3b34e-0c84-4224-a6b5-5a286dc9e12d", + "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": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"DENIED\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7891b04f-3617-4dc8-92bc-6e7d725e7c7d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "common-access" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"access\": {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"name\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"status\": \"DENIED\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "update-status", + "description": "", + "item": [ + { + "id": "a40055ba-3f6c-4811-ac31-5084cd3675fe", + "name": "Bulk update common access status", + "request": { + "name": "Bulk update common access status", + "description": { + "content": "This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update", + "type": "text/plain" + }, + "url": { + "path": [ + "common-access", + "update-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "02ed688c-27e8-4874-be73-8b49eaa93e88", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "common-access", + "update-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c92d1c2-10d9-4220-86fd-eb3d480dd5e9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "common-access", + "update-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cbbaf756-f840-4018-8f88-d9cd2c8f1ed5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "common-access", + "update-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12bc9b5f-f7b8-4563-8215-8a6e9a5a0fdd", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "common-access", + "update-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b75b7ad5-ac0a-4ca4-8b01-edf19daf528c", + "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": { + "url": { + "path": [ + "common-access", + "update-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc72dc18-12bf-4bdc-92b8-29505777a5d1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "common-access", + "update-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"confirmedIds\": [\n \"\",\n \"\"\n ],\n \"deniedIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "identities", + "description": "", + "item": [ + { + "name": "{identityId}", + "description": "", + "item": [ + { + "name": "synchronize-attributes", + "description": "", + "item": [ + { + "id": "e5dc295c-1e8b-4c3b-9d74-adbc0e9b3c72", + "name": "Attribute synchronization for single identity.", + "request": { + "name": "Attribute synchronization for single identity.", + "description": { + "content": "This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities", + ":identityId", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identityId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "fd54c0e4-2ed3-4e8c-a695-dff5c7b0fc5c", + "name": "An Identity Sync job", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identityId", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"status\": \"ERROR\",\n \"payload\": {\n \"type\": \"\",\n \"dataJson\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef00f046-debf-4948-b20a-d69b318c51e9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identityId", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f169de37-2558-45ef-a039-eb83f815b3c6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identityId", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0c791c8-8299-4770-91aa-14337d7040c1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identityId", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4b49d9f-c5c2-4837-b27c-94b62a8c5310", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identityId", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "be9882bc-ac59-40e3-9754-b7e5ffa5a061", + "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": { + "url": { + "path": [ + "identities", + ":identityId", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "826f4a7c-e958-47d5-9517-4f98c62d01dd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identityId", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "id": "72a50ff3-a01b-42d1-9da8-fda886e9061b", + "name": "List Identities", + "request": { + "name": "List Identities", + "description": { + "content": "This API returns a list of identities.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, alias, cloudStatus**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.", + "type": "text/plain" + }, + "key": "defaultFilter", + "value": "CORRELATED_ONLY" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "046ebf7c-375e-474a-8014-2f304c9236ae", + "name": "List of identities.", + "originalRequest": { + "url": { + "path": [ + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, alias, cloudStatus**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.", + "type": "text/plain" + }, + "key": "defaultFilter", + "value": "CORRELATED_ONLY" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"alias\": \"\",\n \"emailAddress\": \"\",\n \"processingState\": \"ERROR\",\n \"identityStatus\": \"TERMINATED\",\n \"managerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"isManager\": false,\n \"lastRefresh\": \"\",\n \"attributes\": {},\n \"lifecycleState\": {\n \"stateName\": \"\",\n \"manuallyUpdated\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"alias\": \"\",\n \"emailAddress\": \"\",\n \"processingState\": \"ERROR\",\n \"identityStatus\": \"ACTIVE\",\n \"managerRef\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"isManager\": false,\n \"lastRefresh\": \"\",\n \"attributes\": {},\n \"lifecycleState\": {\n \"stateName\": \"\",\n \"manuallyUpdated\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d6749127-1349-43af-beff-a5fae00ad00d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, alias, cloudStatus**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.", + "type": "text/plain" + }, + "key": "defaultFilter", + "value": "CORRELATED_ONLY" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1873792-9bbc-447c-909e-8c398001c704", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, alias, cloudStatus**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.", + "type": "text/plain" + }, + "key": "defaultFilter", + "value": "CORRELATED_ONLY" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d437cfea-82a5-4322-902b-98f79b3bd640", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, alias, cloudStatus**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.", + "type": "text/plain" + }, + "key": "defaultFilter", + "value": "CORRELATED_ONLY" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c9cef87-7d1c-4ce5-ba2c-1a41e917a605", + "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": { + "url": { + "path": [ + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, alias, cloudStatus**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.", + "type": "text/plain" + }, + "key": "defaultFilter", + "value": "CORRELATED_ONLY" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "03f7b998-3926-460b-9481-9515b6c6d4d1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, alias, cloudStatus**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.", + "type": "text/plain" + }, + "key": "defaultFilter", + "value": "CORRELATED_ONLY" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "dd05b6ba-3123-486e-a963-5adb2ab70b85", + "name": "Identity Details", + "request": { + "name": "Identity Details", + "description": { + "content": "This API returns a single identity using the Identity ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "82cc73d4-bfb8-4fcf-b14e-29eb5ad27370", + "name": "An identity object", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"alias\": \"\",\n \"emailAddress\": \"\",\n \"processingState\": \"OK\",\n \"identityStatus\": \"TERMINATED\",\n \"managerRef\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"isManager\": false,\n \"lastRefresh\": \"\",\n \"attributes\": {},\n \"lifecycleState\": {\n \"stateName\": \"\",\n \"manuallyUpdated\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a7fee6ae-b819-4525-972f-fa8ab71eed7a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c71e202-97a7-4214-bf3e-c8d37ee2483c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6abbb976-02b4-4f3d-9f73-dfc49fc30323", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "543a37ff-680f-4d12-a226-07312fe88b03", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97308bd4-583b-42d7-9296-0c4cbbd775cb", + "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": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4cddf3c-c708-425a-b05e-d8472ff17a2e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a18eeb15-c029-4b02-8e6a-0f1ad0c58778", + "name": "Deletes an identity.", + "request": { + "name": "Deletes an identity.", + "description": { + "content": "The API returns successful response if the requested identity was deleted.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "6830ab38-fe1a-4750-9117-c3a31c81bbe6", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "95bec804-e9ac-4de7-af3d-1fe597134ac4", + "name": "Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": \"\",\n \"associationDetails\": [\n {\n \"associationType\": \"\",\n \"entities\": [\n {\n \"identityEntity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n },\n {\n \"identityEntity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n }\n ]\n },\n {\n \"associationType\": \"\",\n \"entities\": [\n {\n \"identityEntity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n },\n {\n \"identityEntity\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8ba047d6-fa1e-4791-b002-49f12dd94992", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7311c11f-6fa3-4637-89b7-097cb96a999c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a258e04-d825-48f4-8e23-220a4f2b7c89", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "358ff2c0-cd7e-4b41-a021-36408fd64f41", + "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": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2697bab4-8f14-48f8-8e12-a7996f22f33c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "process", + "description": "", + "item": [ + { + "id": "4f72cc2a-de4d-4215-aecd-8adeae58f38a", + "name": "Process a list of identityIds", + "request": { + "name": "Process a list of identityIds", + "description": { + "content": "You could use this endpoint to:\n1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change).\n2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles.\n3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health).\n4. Recalculate manager relationships.\n5. Potentially clean-up identity processing errors, assuming the error has been resolved.\n\nTo learn more, refer to the [identity processing documentation](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html).\n", + "type": "text/plain" + }, + "url": { + "path": [ + "identities", + "process" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "9c9da49b-7e25-4c80-bbe4-b69358a708fe", + "name": "Object containing the DTO type TASK_RESULT and the job id for the task", + "originalRequest": { + "url": { + "path": [ + "identities", + "process" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9c1d899-f4c0-4a1b-ae45-8e1b9234f4d2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities", + "process" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa9332ed-79ea-4321-976b-3dd2357de656", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities", + "process" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a404ace1-a1c0-40c8-a84f-e8d022fffb5d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities", + "process" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eca53945-8394-4ea6-a55d-4045a2e34246", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identities", + "process" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae846124-bcb7-4290-a19c-2634ae17d8a2", + "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": { + "url": { + "path": [ + "identities", + "process" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f55c3b8c-5b3a-4b81-a5b1-2f57d267d86b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities", + "process" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityIds\": [\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "identity-profiles", + "description": "", + "item": [ + { + "id": "5e3b1c87-3056-4c6b-890b-fed11723f3e4", + "name": "Identity Profiles list", + "request": { + "name": "Identity Profiles list", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c9990196-3337-4544-97fd-51235dafd9b8", + "name": "List of identityProfiles.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"labore__7\": true,\n \"incididunt_f\": -46612278\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"do_\": \"quis cupidatat\",\n \"officia_5\": -78258740,\n \"estf\": 27923543\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n },\n {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_621\": \"ex\",\n \"ullamco2a2\": -62214316.45926736,\n \"occaecat_038\": false\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"et_2_\": -59941037,\n \"nostrud_89\": 7342506.2359482795,\n \"ut_a2\": \"Excepteur do\",\n \"amet_25\": 27754467.871223688\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c2d0399-952a-44e2-b6d5-980f98a7d812", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1b4bc70-258a-493b-aede-29758e7821eb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "58a77ef3-1887-4f9d-8ec3-03fded828e7f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3f051634-3980-4737-8067-4a9fbc0ce8cd", + "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": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b34367fa-cafe-4531-8ec6-59995ba09508", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0a1abb39-104e-4e05-87ae-de0d5b98fa43", + "name": "Create an Identity Profile", + "request": { + "name": "Create an Identity Profile", + "description": { + "content": "This creates an Identity Profile\nA token with ORG_ADMIN authority is required to call this API to create an Identity Profile.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8bd1a6b4-a56e-4096-9fff-7c3fc5ec5b83", + "name": "The created Identity Profile", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "164e499a-e668-4694-b1e1-74c5b55ce6b6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0011d15-aadc-43a3-b439-efdc429e91d7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "69bc4fbb-6b1c-4ee6-98ce-fed446f72e3c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0f121687-f667-4406-9476-2dd1b2a1c9b6", + "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": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a59b4f0-f297-4dd8-829d-e7a243bfb574", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "0a1035b2-a9f8-431e-9068-8d7b17f77ce0", + "name": "Delete Identity Profiles", + "request": { + "name": "Delete Identity Profiles", + "description": { + "content": "This deletes multiple Identity Profiles via a list of supplied IDs.\n\nOn success, this endpoint will return a reference to the bulk delete task result.\n\nA token with ORG_ADMIN authority is required to call this API.\n\nThe following rights are required to access this endpoint: idn:identity-profile:delete", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c6f07b96-a99a-4c8b-b54a-e4c03a137bad", + "name": "Accepted - Returns a TaskResult object referencing the bulk delete job created.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"launcher\": \"\",\n \"completed\": \"\",\n \"launched\": \"\",\n \"completionStatus\": \"Warning\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3cd99092-76e7-4775-b097-745b9fab2ae6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f6bfab1c-0199-4204-86e7-cf296365efd6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0d18e11d-f037-4365-9af3-dd50b7b56cf2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1ab6188-5daf-46c7-8bd7-35b07585c66a", + "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": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b22df8f9-f6cd-47e8-9b76-7fd88da2c77d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "export", + "description": "", + "item": [ + { + "id": "d529a757-f5ae-42b1-ae0a-77a31e4674a2", + "name": "Export Identity Profiles", + "request": { + "name": "Export Identity Profiles", + "description": { + "content": "This exports existing identity profiles in the format specified by the sp-config service.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5fedf7fd-54bf-4f73-a419-360bc6bc660c", + "name": "List of export objects with identity profiles.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"minim_04\": \"\",\n \"in_4b4\": \"\",\n \"proident_6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis62f\": \"\",\n \"idff\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"tempordf0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_d5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3333ca09-4968-4af7-b505-4842b39a73d4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6917366e-6e4c-46b9-8363-2f12ffb70452", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2debc941-ec98-479d-bdd4-f3039c6bd05d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4363ed6c-9ecd-4e69-a331-1e89b80c5cbe", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "66db181b-84f6-4283-bd81-e6ff3482abac", + "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": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67921944-9baf-4c90-8010-de7d250bbc2b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "import", + "description": "", + "item": [ + { + "id": "f29dd6c0-ca5f-4a86-93b3-95340dcc6d0a", + "name": "Import Identity Profiles", + "request": { + "name": "Import Identity Profiles", + "description": { + "content": "This imports previously exported identity profiles.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"minim_04\": \"\",\n \"in_4b4\": \"\",\n \"proident_6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis62f\": \"\",\n \"idff\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"tempordf0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_d5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d7832b5d-bc89-43ef-a0db-f5718766d3e7", + "name": "The result of importing Identity Profiles.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"minim_04\": \"\",\n \"in_4b4\": \"\",\n \"proident_6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis62f\": \"\",\n \"idff\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"tempordf0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_d5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"infos\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"consequat_e70\": {},\n \"aliquip3d3\": {},\n \"ullamco0ea\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"magna_e\": {},\n \"ea_39\": {}\n }\n }\n ],\n \"warnings\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"Lorem38b\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"velit_e\": {}\n }\n }\n ],\n \"errors\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"dolorf07\": {},\n \"ipsum__d5\": {},\n \"proident__a\": {},\n \"velit_0\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"aute73\": {},\n \"aute_0_\": {}\n }\n }\n ],\n \"importedObjects\": [\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45dbd9ad-647b-4b18-bf4c-843a8d6f52a4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"minim_04\": \"\",\n \"in_4b4\": \"\",\n \"proident_6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis62f\": \"\",\n \"idff\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"tempordf0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_d5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3648204a-4a60-4d69-aa2a-c9d685d297c9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"minim_04\": \"\",\n \"in_4b4\": \"\",\n \"proident_6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis62f\": \"\",\n \"idff\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"tempordf0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_d5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73e1500a-ebdf-42a9-9cdf-856514c3fa75", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"minim_04\": \"\",\n \"in_4b4\": \"\",\n \"proident_6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis62f\": \"\",\n \"idff\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"tempordf0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_d5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef1aa593-e8d3-401b-b797-811e4db01c20", + "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": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"minim_04\": \"\",\n \"in_4b4\": \"\",\n \"proident_6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis62f\": \"\",\n \"idff\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"tempordf0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_d5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "794ff5e1-4453-41a7-80f8-b3c0c3c528e3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"minim_04\": \"\",\n \"in_4b4\": \"\",\n \"proident_6\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"Duis62f\": \"\",\n \"idff\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"tempordf0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip_d5\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "identity-preview", + "description": "", + "item": [ + { + "id": "ae97bd5f-4e5c-4da0-99e4-513cdded92a5", + "name": "Generate Identity Profile Preview", + "request": { + "name": "Generate Identity Profile Preview", + "description": { + "content": "This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy's attribute config is applied.\nA token with ORG_ADMIN authority is required to call this API to generate an identity preview.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + "identity-preview" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"eiusmod60\": true,\n \"Duis28c\": \"in\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sit98\": -95247282,\n \"amet0\": false\n }\n }\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4c1d2ab3-e102-47b7-8c2a-0263b0bf4e73", + "name": "Object representing the preview object with all of the identity attributes using the current mappings.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "identity-preview" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"eiusmod60\": true,\n \"Duis28c\": \"in\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sit98\": -95247282,\n \"amet0\": false\n }\n }\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identity\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"previewAttributes\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"previousValue\": {},\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"previousValue\": {},\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "848daa8a-9193-472e-b193-3161e615b83d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "identity-preview" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"eiusmod60\": true,\n \"Duis28c\": \"in\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sit98\": -95247282,\n \"amet0\": false\n }\n }\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a320fac-e757-4ebc-98fe-a4410c687630", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "identity-preview" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"eiusmod60\": true,\n \"Duis28c\": \"in\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sit98\": -95247282,\n \"amet0\": false\n }\n }\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cdd4564d-2552-43ab-a4ae-d8a1062820b4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "identity-preview" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"eiusmod60\": true,\n \"Duis28c\": \"in\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sit98\": -95247282,\n \"amet0\": false\n }\n }\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "431ef989-7c81-4517-91c5-4b12559dd0bb", + "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": { + "url": { + "path": [ + "identity-profiles", + "identity-preview" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"eiusmod60\": true,\n \"Duis28c\": \"in\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sit98\": -95247282,\n \"amet0\": false\n }\n }\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "935cf562-3ee1-47af-be2f-7e75b6c4278c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "identity-preview" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"eiusmod60\": true,\n \"Duis28c\": \"in\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sit98\": -95247282,\n \"amet0\": false\n }\n }\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{identity-profile-id}", + "description": "", + "item": [ + { + "id": "77e7551f-c031-47e2-81ff-27af934ae897", + "name": "Gets a single Identity Profile", + "request": { + "name": "Gets a single Identity Profile", + "description": { + "content": "This returns a single Identity Profile based on ID.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "da0cd2ea-8e62-4532-8a5f-8c4d843984e9", + "name": "An Identity Profile object", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3296482e-dda5-4dd9-be95-4f7d804138c1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bdcaa8da-924e-4ca8-89f7-330e8cfa8985", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7ee695c-b689-4b5e-9270-c495677a5875", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecd5ea1a-ce21-4c55-b376-b8e7bd5067b4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98f21615-70a2-49cb-a352-4bf807e6d85f", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d050b8a-104f-4830-ace0-e379526f11e6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0d480e91-c584-49d5-be17-93372ff1930d", + "name": "Delete an Identity Profile", + "request": { + "name": "Delete an Identity Profile", + "description": { + "content": "This deletes an Identity Profile based on ID.\n\nOn success, this endpoint will return a reference to the bulk delete task result.\n\nA token with ORG_ADMIN authority is required to call this API.\n\nThe following rights are required to access this endpoint: idn:identity-profile:delete", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "a1cf0315-7e17-4c77-b0c2-46cb32d92e86", + "name": "Accepted - Returns a TaskResult object referencing the bulk delete job created.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"launcher\": \"\",\n \"completed\": \"\",\n \"launched\": \"\",\n \"completionStatus\": \"Terminated\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dbdaa0b9-e1db-4168-bf05-50a3719ad4cb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32250a52-a4d2-4ece-8b98-c256eeff6cf8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb5f878a-b04b-49e9-9a34-6d06a2f6259d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4c5e14d5-2ef8-4dc1-bfcd-5a11720492b0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45220381-e7de-4f79-87a8-ebb787708cc6", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "876bd29d-15dd-45f7-bca7-d0634089512e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "996107a8-c704-4e49-8875-7cc61b936c5d", + "name": "Update the Identity Profile", + "request": { + "name": "Update the Identity Profile", + "description": { + "content": "This updates the specified Identity Profile.\nA token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below.\n* id\n* name\n* created\n* modified", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "cb177959-3725-42b4-a8ed-22282e595dc1", + "name": "The updated Identity Profile.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"reprehenderit_f7\": 68466864\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sint_6b\": \"sin\",\n \"sunt_aad\": true,\n \"consequat_aa\": \"anim veniam sunt occaecat\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": true\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef1bf0f6-7792-4eb7-b810-1e6e7f5fbd54", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ae6285d-b226-452f-a9a5-d042f6eafb8e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5176e80-77b0-4209-8e3e-f24f4c3ae7c7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8698125-13d9-4834-b4da-782e566e2657", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "180935a9-b982-47ca-a8ba-df10468d83bd", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2875e27e-9cc9-4ce8-899a-66a6bafec2e5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "default-identity-attribute-config", + "description": "", + "item": [ + { + "id": "31a4b1f8-168e-4d1d-b3f7-33b94904e9df", + "name": "Default identity attribute config", + "request": { + "name": "Default identity attribute config", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "01877bc0-e1c3-497b-9493-4078fab3f68d", + "name": "An Identity Attribute Config object", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"fugiat42e\": -7223967,\n \"nisi290\": -46015024.483155996,\n \"voluptate_d7c\": -17332330.227891818,\n \"et5ff\": 969168.9058214128\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"velita\": 37915339,\n \"sunt53\": 67402541.36945629\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "928783a7-4db1-414d-83d2-5381547819a7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c8b31119-84d2-4bbe-820e-550d6fa6e1b9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f54a8f33-500e-4110-8878-5cacf0528b18", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb7820ad-a333-4271-873b-1324a7fde8b7", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "43e48ed6-eae8-4dd2-84d6-a290b1d72f3b", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b1fcede-5fea-4505-9765-1ae7b1531d22", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "process-identities", + "description": "", + "item": [ + { + "id": "8da57357-65c8-46c6-9ed2-70e8b926b030", + "name": "Process identities under profile", + "request": { + "name": "Process identities under profile", + "description": { + "content": "Process identities under the profile\n\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "2bcc9b0e-4e49-4825-a7b7-0e4455e6aba8", + "name": "Accepted status after refresh has launched", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3fb76ed1-c9fb-4b28-af82-6d6cb68355a6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d3eda7b-9328-4869-9d9a-76098a876bbf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa6fa5e6-7beb-4358-b853-dd0cf6b3b4aa", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca2c7773-3480-4538-98e3-8b28329f73f4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "040aa7ae-5a8e-4162-9487-e73a70cf3f8b", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "70a5ea97-3adf-4597-bbab-d9923611e846", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "lifecycle-states", + "description": "", + "item": [ + { + "name": "{lifecycle-state-id}", + "description": "", + "item": [ + { + "id": "8ee18769-c486-4cd2-9cbd-0ce18a8959f1", + "name": "Lifecycle State", + "request": { + "name": "Lifecycle State", + "description": { + "content": "This endpoint returns a lifecycle state.\n\nA token with ORG_ADMIN or API authority is required to call this API.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "lifecycle-state-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "51bd7b70-53b7-4d97-ab9c-fa25a55aaf10", + "name": "lifecycle-state", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"technicalName\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9906f883-61f0-4ec8-89a3-aec7b069eda7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5eacbd3-a54d-4f07-b9a5-50e007d0eb52", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a710013-58a3-4026-ac8b-92e10ba5554e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e8628ca-d671-4dcf-9ad0-dc23c69e5ee6", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "80332689-b9a0-4269-a9d0-12ae83563894", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "76948763-a7dd-476f-9afa-367c5378c048", + "name": "Update Lifecycle State", + "request": { + "name": "Update Lifecycle State", + "description": { + "content": "This API updates individual lifecycle state fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nA token with ORG_ADMIN or API authority is required to call this API.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "lifecycle-state-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ba8be8b0-9cd7-4823-940c-1899107f8339", + "name": "Updated lifecycle-state.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"technicalName\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fd740483-abfe-4229-b932-416d516f2f28", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a0914d4-0f37-43ba-b236-bcaf49e7594e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d365748f-fea0-41f3-a925-f104f7e92c5b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "08f53e7b-e46a-4785-ad1e-424e3fcc052c", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab2d6375-9a9a-482c-96b3-5d8a659ab97c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "non-employee-records", + "description": "", + "item": [ + { + "id": "24ed3a40-936a-46d1-bae3-ccba0a08ab5f", + "name": "Create Non-Employee Record", + "request": { + "name": "Create Non-Employee Record", + "description": { + "content": "This request will create a non-employee record.\nRequest will require the following security scope:\n'idn:nesr:create'", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c163cbd9-3623-405a-ba65-319229663603", + "name": "Created non-employee record.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"sunt_7\": \"\",\n \"in_c3\": \"\",\n \"cillum_a_\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b2baed8-233a-4187-8f2b-aac2355e3ebd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc5ea5a8-d580-4051-9477-2b5c5296f387", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "357bdbcb-9fe4-45e5-8be5-be29299cc29f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4cdac8d0-79e1-4126-93dd-f26ca0581546", + "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": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecdeb789-513d-49b4-85c5-d481c508d5cf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b60c6125-14ab-4335-8b5f-1f76d99e7f59", + "name": "List Non-Employee Records", + "request": { + "name": "List Non-Employee Records", + "description": { + "content": "This gets a list of non-employee records.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "093e163b-f174-43da-bc03-bc16e539ce4a", + "name": "Non-Employee record objects", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"ut5\": \"\",\n \"Ut_0b4\": \"\",\n \"eiusmod_2d8\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"minim_b0\": \"\",\n \"ea83c\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a3c370c1-cbb6-49c2-9e7e-ae7d1dcf0367", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aec3648e-dd52-4cc9-bc7a-e47b4e4e6ad0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a53ed70-dc3c-452c-ba1f-55801243b35e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef1a22fd-7c38-4dac-bbdb-f797707a58e6", + "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": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7c7d8291-ac0c-4874-aa0d-184a6fd451f6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "c69f0791-a0b2-4848-b5e0-006f4f359253", + "name": "Get a Non-Employee Record", + "request": { + "name": "Get a Non-Employee Record", + "description": { + "content": "This gets a non-employee record.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "b25f4cd5-91e3-4464-afb5-01dd95da815c", + "name": "Non-Employee record object", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"sunt_7\": \"\",\n \"in_c3\": \"\",\n \"cillum_a_\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0fc5ce2a-2ad2-43bf-aa5e-e538b286f8a6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb34729c-411c-4879-9cbb-41dbbc772092", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3dc67fa2-ad4c-4d95-928a-b2a274effb3b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "50a667f8-fedb-486b-a903-1e042c52d79a", + "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": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e72339c3-d094-4568-a2e8-c4523d269172", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4f6f96c8-f675-4f93-b17b-349da4748170", + "name": "Update Non-Employee Record", + "request": { + "name": "Update Non-Employee Record", + "description": { + "content": "This request will update a non-employee record.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f374546a-e9cc-4e43-ae8e-c63a6f98f4f8", + "name": "An updated non-employee record.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"sunt_7\": \"\",\n \"in_c3\": \"\",\n \"cillum_a_\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "055c43c1-cfdc-460d-bd22-6210a62e1618", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d29e5a80-b83b-4030-bd5c-070ce60d1fab", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3bfc461-0cb7-496c-9cb8-bee060c96982", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d4f2af1-7690-42a1-ae21-fe845e1041db", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d6b25440-d8e7-4394-bbf7-a405a3f2e0be", + "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": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "84452c06-3ca6-4014-a9db-6dccb5c22d41", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f7ec5f57-6424-4723-b152-d8f9a626bd60", + "name": "Patch Non-Employee Record", + "request": { + "name": "Patch Non-Employee Record", + "description": { + "content": "This request will patch a non-employee record.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f0d5ab40-915c-49e5-8516-d8bc323c5696", + "name": "A patched non-employee record.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"sunt_7\": \"\",\n \"in_c3\": \"\",\n \"cillum_a_\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d542f2a-ea1b-43ba-acbd-db2741eaddbd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "84be2899-6874-4d86-9585-2e16cb0bb4b0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "727a7ead-b272-493d-b196-8a510fab26c4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "119983f4-6778-47bf-bfb9-efa471f9c20c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecc6f17d-97e7-4395-b968-167b9ebe51f4", + "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": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3b764c5b-9e43-40bc-9745-ee34b6edbe1c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a2af6ee9-7b53-4223-ad26-bf83b3f8f641", + "name": "Delete Non-Employee Record", + "request": { + "name": "Delete Non-Employee Record", + "description": { + "content": "This request will delete a non-employee record.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "a7a366e2-8298-42e1-8074-597711191eb8", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "b63295be-e826-4b36-a6c9-d60febbb22ce", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "738689f6-a4de-47cc-be71-409116270cd1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45ee0094-cfa9-4240-98dc-2f1ef8a3eba4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a849e22-84a8-4213-b21c-1e02ca676270", + "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": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31800ca7-deaf-423b-8967-91f0d2dc7a5e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "c15734d8-bc16-4e54-96bc-5cb66474a121", + "name": "Delete Multiple Non-Employee Records", + "request": { + "name": "Delete Multiple Non-Employee Records", + "description": { + "content": "This request will delete multiple non-employee records based on the non-employee ids provided.\nRequest will require the following scope:\n'idn:nesr:delete'", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "299e3edc-4c65-4e37-a0bd-750dce5e6cfc", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "6232175b-2855-4b8c-b316-b238ce8c18de", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf47acf9-c773-4e60-8900-2f21684a0d29", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "56b36061-9be5-49c3-bd88-c1079e014f7f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "516af1f7-b305-4133-b951-402a330c1fa4", + "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": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e4b955fc-f161-4abc-8b21-446ff0dcbbc0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "non-employee-requests", + "description": "", + "item": [ + { + "id": "21eab1e6-7a3b-47fc-a977-22b7af84ae27", + "name": "Create Non-Employee Request", + "request": { + "name": "Create Non-Employee Request", + "description": { + "content": "This request will create a non-employee request and notify the approver", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7fd06ef9-f959-4852-88d3-793c61c263e1", + "name": "Non-Employee request creation object", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"voluptate_3_6\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"APPROVED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bd0ca48d-1f56-40f5-b082-a3b843862a7c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9e78c21a-aea2-43fe-bc5b-f28ee82e7218", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "653a40f4-b2b6-4709-bcbd-e5d14d7a66ec", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a8c2503-6caf-46a9-8716-4eae5c06577d", + "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": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e17aaf82-d7de-48ac-a66b-0c44e43e9159", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"quis_0\": \"\",\n \"esse93\": \"\",\n \"esse_4\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4e6615ab-d830-40ad-9f52-5c08ccc2d824", + "name": "List Non-Employee Requests", + "request": { + "name": "List Non-Employee Requests", + "description": { + "content": "This gets a list of non-employee requests.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "200889f1-8e8e-4137-ba6a-56adc45e01f5", + "name": "List of non-employee request objects.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"id5\": \"\",\n \"Excepteur29\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"REJECTED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"PENDING\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"doloree41\": \"\",\n \"Excepteur__85\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"REJECTED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9e7a0fd-c934-4ecb-baaa-f3e0f7640e4c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f71abd1-f1f8-49ce-8061-883e9cb90825", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb86befd-6387-415c-906e-348bdfb0a728", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a871cb41-c9d3-43e9-8a99-4c7c62cefc52", + "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": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65c56b7c-ac4e-42c4-a260-c58c695dba4b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "a5c41fed-fe5b-4517-a8b3-6fed5dcaf614", + "name": "Get a Non-Employee Request", + "request": { + "name": "Get a Non-Employee Request", + "description": { + "content": "This gets a non-employee request.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f6dad5ca-5c29-4598-be7a-8c093ec89966", + "name": "Non-Employee request object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"voluptate_3_6\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"APPROVED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "327f8ee1-71dc-4ccc-aaf5-1876d4e6139a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "03d51436-8d01-43d5-a623-7a263b8c6360", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cbae845-179b-4827-bcf3-519314ec7da4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3cfe1a5a-895b-44e5-87ce-64279e103fae", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b754acfc-8a24-4ec2-a34d-d2f59058c27a", + "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": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97d3e665-6e0d-4cf4-bac0-69b0bd9d03ee", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c546a525-2bbb-48ba-910b-093338cca422", + "name": "Delete Non-Employee Request", + "request": { + "name": "Delete Non-Employee Request", + "description": { + "content": "This request will delete a non-employee request.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "c96cab5e-fab1-410c-9bbe-f0e418f61be4", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "4a742ffb-0f57-4b8b-ac12-fe35ee9dfbf4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e6f1f92-54d0-4f2e-9127-b50c46b7037a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d16f4c78-2cdb-4d04-aa06-991169ba19ea", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99daac6a-22b0-45d2-bec3-89f349fa52e0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6083747-7466-4b12-8fed-b81b3d179b9b", + "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": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f6513a6-13c3-41ec-89c9-c53ce058c73e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "summary", + "description": "", + "item": [ + { + "name": "{requested-for}", + "description": "", + "item": [ + { + "id": "9e667279-fb06-4607-af18-de5cdb22e604", + "name": "Get Summary of Non-Employee Requests", + "request": { + "name": "Get Summary of Non-Employee Requests", + "description": { + "content": "This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, 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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "requested-for", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4ef47ec4-bb03-4e72-97a6-977ed91a7506", + "name": "Non-Employee request summary object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"approved\": \"\",\n \"rejected\": \"\",\n \"pending\": \"\",\n \"nonEmployeeCount\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "169cfd51-f3bf-4b3f-9d24-cbdf0dbb913a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "009dc51c-f1c1-4ff6-8a41-66f28de6cbb6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48dac24a-d482-492e-ae6f-8883a2aa8713", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7391d913-5471-401d-882e-a2be17cc5151", + "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": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9bd04f7d-41f9-47bf-8110-78f07aac4804", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "non-employee-sources", + "description": "", + "item": [ + { + "id": "30783273-df11-4606-b496-4d8a8d583b4e", + "name": "Create Non-Employee Source", + "request": { + "name": "Create Non-Employee Source", + "description": { + "content": "This request will create a non-employee source.\nRequest will require the following security scope:\n'idn:nesr:create'", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1f9a6768-8a29-4822-8dc3-721fab98f995", + "name": "Created non-employee source.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\",\n \"cloudExternalId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0950041f-acd5-4aaf-b978-6cb2e5d669b9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c39b1e1e-3d43-4efb-b2d0-4f7eb58e54fb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "558d7dfe-96ed-45bf-8a74-7aa73dfdc595", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "300862c1-1165-495f-8f8f-cb50e666aa0f", + "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": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "502c4c3c-a665-4fd2-a619-acee9f392e84", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b6db6f8e-baf0-4fc7-9af2-5a317ef41b61", + "name": "List Non-Employee Sources", + "request": { + "name": "List Non-Employee Sources", + "description": { + "content": "This gets a list of non-employee sources.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "(Required) The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4e1e29c1-1d9e-4cbc-8b7f-6cda0c1e8586", + "name": "List of non-employee sources objects.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "(Required) The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"RULE\",\n \"id\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57e15c20-250e-4d24-a1bd-bf5039ff0619", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "(Required) The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "559fb938-ead8-453e-bba8-346ca4246d8e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "(Required) The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e23baf13-d896-45ac-977c-877dce453d25", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "(Required) The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3b172b7-1bfc-4360-9780-740d58a20f17", + "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": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "(Required) The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "314f4cf7-5186-4f8a-9980-5afcd2b298a3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "(Required) The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{sourceId}", + "description": "", + "item": [ + { + "id": "ed46dd1f-c276-4a8a-ad51-7b7354405748", + "name": "Get a Non-Employee Source", + "request": { + "name": "Get a Non-Employee Source", + "description": { + "content": "This gets a non-employee source.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "a4983916-e140-44ee-92d1-96e5e49b27b8", + "name": "Non-Employee source object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf116247-019d-48a0-b047-fc51c600e5e1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a17741e1-3862-4fe3-95b4-a621c0c03db3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7124f046-57ab-4613-82ce-efd2075f8436", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b05d42b3-87df-4fc3-a00e-ad9ba72f9909", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4dd0c1c6-ecb1-4a00-ab09-84a4aa95bd46", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "3e0de45f-467d-4b88-8089-ad079b48e281", + "name": "Patch a Non-Employee Source", + "request": { + "name": "Patch a Non-Employee Source", + "description": { + "content": "patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers**", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8681f8e8-98b0-471f-a2a2-bcca7b37f471", + "name": "A patched non-employee source object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d3a14ca-0f14-40bf-83ad-7bea9bb4f90c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "226a00d0-6fbd-47aa-9b95-5d1196f0be68", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "355e9803-56f0-479a-a250-2fd9436b01ce", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c83e593-23fe-47b5-ba87-9d5561f425ae", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b11ff25f-f12f-47aa-b4c8-5261750710ec", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "66531a9f-f5ef-47cd-8252-8173af2a41ed", + "name": "Delete Non-Employee Source", + "request": { + "name": "Delete Non-Employee Source", + "description": { + "content": "This request will delete a non-employee source.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "fff08a36-ac76-443f-95b8-e657011a0f50", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "7e3d8c10-86fc-4eb2-9a94-082657a5a329", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c655dd89-20ff-4351-b6a1-d37a2eaa77ac", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7edd5944-4fcf-4657-a7c0-bcefe0655bee", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "512fe678-4749-4880-bde7-994094c23c01", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33e1f266-b78d-48f8-aa55-ea7b35576ef1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "schema-attributes", + "description": "", + "item": [ + { + "id": "ac16ea91-ff44-4480-ac6e-04def30dd8c1", + "name": "List Schema Attributes Non-Employee Source", + "request": { + "name": "List Schema Attributes Non-Employee Source", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "495c0d5b-a943-476d-94c4-737a368a6d87", + "name": "A list of Schema Attributes", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n },\n {\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7046b345-1f47-47e8-b7c6-2722caaba942", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a61b04ef-5b9a-4250-82bd-d96016de1d94", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "78726a3a-2b1a-4ad3-a5b2-24609746c3c3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "60e7cae6-caf1-4d59-8075-25ac2120eef6", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4975ba33-c81a-491b-9a04-cf2baaa6688e", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45e47f7e-93eb-493b-a941-0a4553375e66", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "14d1f5bb-06f8-42f7-a94a-04800655aaba", + "name": "Create Non-Employee Source Schema Attribute", + "request": { + "name": "Create Non-Employee Source Schema Attribute", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f4b0f654-1de3-4d83-adab-963c975542d6", + "name": "Schema Attribute created.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42d4afdc-0d95-41f1-9fa4-38e1f0e3578a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd931e69-da49-4132-ac74-667fd860b5f2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "610a1fdf-c6b8-4c39-8732-f269f7e93086", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5a1f6d2b-55c8-4a97-8fdf-478b009c4bc0", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "43ee8eb3-5cdb-49a8-bfbc-f4c54410ba63", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "363abff7-5008-4bb1-966f-c5b518d9f326", + "name": "Delete all custom schema attributes", + "request": { + "name": "Delete all custom schema attributes", + "description": { + "content": "This end-point deletes all custom schema attributes for a non-employee source.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "1592e8e7-d950-498c-be35-a4a378324f7b", + "name": "All custon Schema Attributes were successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "f66f9625-c203-473b-a55f-4349f650a629", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bbb8e8d-3181-4c80-a951-e503338a10e0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "70659f2d-1a9b-417d-8313-48aaed68312c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ee11b8e-1251-447a-b36c-f59b3731919b", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb7a69b6-d1c1-478a-b371-1058e8eb096f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{attributeId}", + "description": "", + "item": [ + { + "id": "ddb077b7-0c4c-453d-966c-5d606c950d6a", + "name": "Get Schema Attribute Non-Employee Source", + "request": { + "name": "Get Schema Attribute Non-Employee Source", + "description": { + "content": "This API gets a schema attribute by Id for the specified Non-Employee SourceId.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attributeId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "44ff818c-2d45-4148-a608-9b101427df5e", + "name": "The Schema Attribute", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c81b7a91-4411-4b35-aaec-484b0dcbf5c9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a462c83-a1e0-4e6d-a490-a43090c32358", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ff0b7a7-2329-4947-83c0-c5c3ac832d5f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ac43b6ba-2c2c-4ad4-8dc2-12e6cdeaa7c1", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0cfbf82-da47-4bd1-91cc-e939ac60e396", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "578c2604-7d96-46a3-868b-25d5e609c64b", + "name": "Patch Non-Employee Source's Schema Attribute", + "request": { + "name": "Patch Non-Employee Source's Schema Attribute", + "description": { + "content": "This end-point patches a specific schema attribute for a non-employee SourceId.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attributeId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "61c7bf68-04c1-4e51-b560-60ade4192c09", + "name": "The Schema Attribute was successfully patched.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a3a1009-a450-402b-b07c-7a432a379313", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db851ce0-37d6-4af9-bfce-2acffe5fc6d7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3f8a73b0-60e4-4a45-b8d4-94a3a0e3c217", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3daff7cc-01bc-4b2a-825e-0ae15a648856", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89d8f261-b194-4aba-9f2b-1e6c79dc9b04", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "41a0659c-cb4f-4a3d-88fa-507c160e607a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "49904f26-0428-460b-b6b5-da1934edf8d5", + "name": "Delete Non-Employee Source's Schema Attribute", + "request": { + "name": "Delete Non-Employee Source's Schema Attribute", + "description": { + "content": "This end-point deletes a specific schema attribute for a non-employee source.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attributeId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "987713a6-96c8-497c-93ea-ae438ea43cd1", + "name": "The Schema Attribute was successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "2c34b334-f4c7-4bb2-a678-d6dd3695c3a8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "961ed946-02e3-4c53-b439-95206d81c1af", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e38c128-6118-4d74-8987-16b7406a42e1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca624f0c-10d5-47f8-9237-a063c8023fbb", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e3b07433-fbdd-42fa-9f9f-7606cba39b41", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "name": "non-employees", + "description": "", + "item": [ + { + "name": "download", + "description": "", + "item": [ + { + "id": "50faed3d-32ce-4ec5-8bff-f90e787b8a74", + "name": "Exports Non-Employee Records to CSV", + "request": { + "name": "Exports Non-Employee Records to CSV", + "description": { + "content": "This requests a CSV download for all non-employees from a provided source.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "46ca062c-434b-46ad-b0f8-f3aa945d25bc", + "name": "Exported CSV", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{\n \"example\": \"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\"\n}", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "b2f3d7c1-e003-4bf5-8d8b-e503a91012d3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6672e035-1585-4f0c-92ce-8a33708f5ddb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3868f715-0301-4d88-99b4-ef4eb2ffbe69", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2d786ee-9185-4cd3-a28f-1afe62b28751", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e4be2956-cfc1-4c28-ba7b-01a51810e7f6", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ceaf0af8-ab7a-46c5-8059-01ee7824c175", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "non-employee-bulk-upload", + "description": "", + "item": [ + { + "id": "e3cbe074-262e-4aef-a809-4eedc31e7702", + "name": "Imports, or Updates, Non-Employee Records", + "request": { + "name": "Imports, or Updates, Non-Employee Records", + "description": { + "content": "This post will import, or update, Non-Employee records found in the CSV.\nRequest will need the following security scope:\n'idn:nesr:create'", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "d6cfc2a3-e934-42a7-a1f5-a9741191efe6", + "name": "The CSV was accepted to be bulk inserted now or at a later time.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"status\": \"IN_PROGRESS\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "03242b91-0f10-4bfe-af96-61457eb069b3", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4220a70-abfd-4c6f-9017-fee893491592", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "05cf5d3a-a8b4-41c5-a9e4-10eca558b5fb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "163380ba-be13-4f02-a9cc-c35533280b23", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "635e824c-db72-45dd-8dd9-114416d68c6d", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6d92f6d4-31c0-4296-9498-6904cdf9e4b0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "status", + "description": "", + "item": [ + { + "id": "286ed8c5-56e5-4113-9692-18b037a0b181", + "name": "Bulk upload status on source", + "request": { + "name": "Bulk upload status on source", + "description": { + "content": "The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6e86006d-b9e1-4a84-9902-9f9253b3cac4", + "name": "Status of the newest bulk-upload job, if any.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"status\": \"PENDING\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae34f3b6-13dd-4d01-aa0f-7144721681be", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c5ec24e6-be72-4790-93a9-4ebfe91f3bfb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38b6c48a-dc2c-4764-88d2-d7361548ad2b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1bf31152-7b31-4ed8-a584-037729e59906", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a7babff-e8f7-4271-867a-3b980d484f4f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "schema-attributes-template", + "description": "", + "item": [ + { + "name": "download", + "description": "", + "item": [ + { + "id": "2a137afc-3b3a-425b-af84-e5bb0cbfdb05", + "name": "Exports Source Schema Template", + "request": { + "name": "Exports Source Schema Template", + "description": { + "content": "This requests a download for the Source Schema Template for a provided source.\nRequest will require the following security scope:\nidn:nesr:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "a35f6bc1-0b72-47ca-8400-e47007b87735", + "name": "Exported Source Schema Template", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{\n \"example\": \"accountName,firstName,lastName,phone,email,manager,startDate,endDate\\n\"\n}", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "ce0aa2e1-f005-47fc-bb3c-16c35952255e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e6757a14-e71b-471b-9972-c1b25de42f5b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40b33084-fc1b-47f0-acd9-ee402c7513ac", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab78bfb1-dae0-4d8a-b314-d4fd6fc182de", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0d836557-395c-4904-9a90-846f84b8e9c5", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc2c1e2f-9ee4-4cc3-9e15-c94b05b428c5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "non-employee-approvals", + "description": "", + "item": [ + { + "id": "3d542cea-2c66-46f9-9aad-ca18dd8842a6", + "name": "Get List of Non-Employee Approval Requests", + "request": { + "name": "Get List of Non-Employee Approval Requests", + "description": { + "content": "This gets a list of non-employee approval requests.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6eadb32a-295b-4043-8493-2426ff350b88", + "name": "List of approval items.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\"\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4daabf9c-6112-4a08-8e5b-b04fdb155033", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "529cac53-3292-41b7-9db4-99a1ed7d2e17", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d0b97de1-7744-4d03-b3a6-096918db44de", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "867bddd5-981c-4e68-b84c-d5600e6dd024", + "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": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "badf6c35-b7e3-4747-a900-8258b59e0e8c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "5d9c7914-ab08-4c0a-a3e6-69c8d70bd511", + "name": "Get a non-employee approval item detail", + "request": { + "name": "Get a non-employee approval item detail", + "description": { + "content": "Approves a non-employee approval request and notifies the next approver.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6188c7ab-bf1f-4fcf-83ae-cfa2e2723466", + "name": "Non-Employee approval item object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"schemaAttributes\": [\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n },\n {\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n }\n ]\n },\n \"data\": {\n \"aliquip1\": \"\"\n },\n \"approvalStatus\": \"PENDING\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a266732e-bac5-4a67-9c77-cf7a967f1924", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "70638b65-9184-404c-9017-243854a73408", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45bfb567-dff1-4d75-9fde-82fc3be989d0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a5d2021-ef93-43af-bce3-7faab70a1aec", + "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": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d9116a1-6b63-4af9-877b-e5c4b25e61fb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "approve", + "description": "", + "item": [ + { + "id": "7b5a3312-1b8a-4610-a938-7b7b373c4477", + "name": "Approve a Non-Employee Request", + "request": { + "name": "Approve a Non-Employee Request", + "description": { + "content": "Approves a non-employee approval request and notifies the next approver.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "351e3c6f-ae38-43d1-bd0d-0b0f598bd549", + "name": "Non-Employee approval item object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36eb2aea-3e4d-4a4f-b431-e3681f84c951", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2037250f-42c4-4192-83a0-1fe35369c4d4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24080987-ddfa-40bc-8d0b-298a40fdb21a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2beb1cd-ee99-4b43-bc5e-04c161797d40", + "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": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "84ab891b-b381-47df-ad65-8b16ced0a36a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reject", + "description": "", + "item": [ + { + "id": "9eb48785-f997-478b-8398-a6fe3598e1f2", + "name": "Reject a Non-Employee Request", + "request": { + "name": "Reject a Non-Employee Request", + "description": { + "content": "This endpoint will reject an approval item request and notify user.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "76e2cbd3-6f4f-4094-9e8b-b24e82f08118", + "name": "Non-Employee approval item object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fc651759-7947-496f-bcb2-2447d835338d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b33a784-32b8-4d96-9714-388ecaee41af", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99944a0a-1960-4193-8e0f-3a77224e5bfa", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45c1b4aa-ed7e-41bd-a39b-496e529282cc", + "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": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "273e5f05-250f-484e-a919-2b9f362eda77", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "summary", + "description": "", + "item": [ + { + "name": "{requested-for}", + "description": "", + "item": [ + { + "id": "59c6f58e-4ab9-43ae-93cf-e05b7efeb702", + "name": "Get Summary of Non-Employee Approval Requests", + "request": { + "name": "Get Summary of Non-Employee Approval Requests", + "description": { + "content": "This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, 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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "requested-for", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6da8b77e-81d0-4f0c-a5e8-a5caf145e2a7", + "name": "summary of non-employee approval requests", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"approved\": \"\",\n \"pending\": \"\",\n \"rejected\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d7c06d8-dba8-4e34-9c1c-293e1f34d213", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "822c5f98-ec24-4afa-8e34-5014b38fc896", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3c5ba820-7615-4e81-a193-ddc709f691a8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f53cfaa-51da-4fd8-9beb-f008193acaea", + "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": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2cfa79e-b4b6-4019-9e21-ef4ce0ef8429", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "managed-clients", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "name": "status", + "description": "", + "item": [ + { + "id": "e50d12ed-ece6-4f67-9dba-13e73fef38e4", + "name": "Specified Managed Client Status.", + "request": { + "name": "Specified Managed Client Status.", + "description": { + "content": "Retrieve Managed Client Status by ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the Managed Client Status to get", + "type": "text/plain" + }, + "key": "type", + "value": "VA" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c243e9b8-387b-4b87-b3e9-8cc7de3fff10", + "name": "Responds with Managed Client Status having the given ID and Type.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the Managed Client Status to get", + "type": "text/plain" + }, + "key": "type", + "value": "VA" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8718520f-0f51-46e9-9640-e6b345916d08", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the Managed Client Status to get", + "type": "text/plain" + }, + "key": "type", + "value": "VA" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3db5e172-cefb-43f2-8f7d-9bcf533d9088", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the Managed Client Status to get", + "type": "text/plain" + }, + "key": "type", + "value": "VA" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd4654aa-fb47-495c-84d2-02ca53405952", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the Managed Client Status to get", + "type": "text/plain" + }, + "key": "type", + "value": "VA" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eff7465e-8cc9-4301-b821-deb62e5880d5", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the Managed Client Status to get", + "type": "text/plain" + }, + "key": "type", + "value": "VA" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab73f88a-bc69-412b-bbfe-fb0ad736515b", + "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": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the Managed Client Status to get", + "type": "text/plain" + }, + "key": "type", + "value": "VA" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a5a45d9-856a-4eea-ad1b-6a647b8daffd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Type of the Managed Client Status to get", + "type": "text/plain" + }, + "key": "type", + "value": "VA" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1eb92f26-910f-4a47-a9d4-c2e5032899dd", + "name": "Handle status request from client", + "request": { + "name": "Handle status request from client", + "description": { + "content": "Update a status detail passed in from the client", + "type": "text/plain" + }, + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c8fee112-faed-4bae-a948-53430e6bc9ad", + "name": "Responds with the updated Managed Client Status.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"body\": {},\n \"status\": \"FAILED\",\n \"type\": \"CCG\",\n \"timestamp\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cf3f165-02cb-4bb7-9d0c-588568011324", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3244afaa-7787-428e-9e66-0d8a77f2d825", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "79a60b83-dd7e-4ccf-bbf9-8ffcbd9b2811", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c2f7a437-de5b-406c-a12d-39d00fadcd6c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "033deb2f-6bca-49a6-a1f5-a36eb08d26e2", + "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": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d0db5a35-71f4-4227-b1d3-ca14b305df29", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "managed-clients", + ":id", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"body\": {},\n \"status\": \"CONFIGURING\",\n \"type\": \"VA\",\n \"timestamp\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "managed-clusters", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "18723236-bbe6-4a16-a3ab-b18d0de13678", + "name": "Get a specified ManagedCluster.", + "request": { + "name": "Get a specified ManagedCluster.", + "description": { + "content": "Retrieve a ManagedCluster by ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "managed-clusters", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4083a2a1-6133-49da-a0f5-1f87d193004c", + "name": "Responds with ManagedCluster having the given ID.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"clientType\": null,\n \"ccgVersion\": \"\",\n \"name\": \"\",\n \"pod\": \"\",\n \"org\": \"\",\n \"type\": \"idn\",\n \"configuration\": {\n \"incididunt_731\": \"\"\n },\n \"keyPair\": {\n \"publicKey\": \"\",\n \"publicKeyThumbprint\": \"\",\n \"publicKeyCertificate\": \"\"\n },\n \"attributes\": {\n \"queue\": {\n \"name\": \"\",\n \"region\": \"\"\n },\n \"keystore\": \"\"\n },\n \"description\": \"\",\n \"redis\": {\n \"redisHost\": \"\",\n \"redisPort\": \"\"\n },\n \"pinnedConfig\": false,\n \"logConfiguration\": {\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"eiusmode_d\": \"INFO\",\n \"anim9\": \"INFO\",\n \"minim_42\": \"INFO\",\n \"sed_7\": \"INFO\"\n }\n },\n \"operational\": false,\n \"status\": \"\",\n \"publicKeyCertificate\": \"\",\n \"publicKeyThumbprint\": \"\",\n \"publicKey\": \"\",\n \"alertKey\": \"\",\n \"clientIds\": [\n \"\",\n \"\"\n ],\n \"serviceCount\": 0,\n \"ccId\": \"0\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c18c33e-bb62-4ec6-8d14-8f24222a784f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1c602779-c251-4c7a-9502-0abeea569a26", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c8eeaf74-836d-4d9c-a092-b8b2e8ab89d9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3735e036-b61a-483c-b6a1-74bf364015ed", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9d3fd411-1808-4a87-8e34-044e2f5c7013", + "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": { + "url": { + "path": [ + "managed-clusters", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "607d3a14-e9a4-4d39-9cbe-314e4533c6b6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "log-config", + "description": "", + "item": [ + { + "id": "f4ded015-de45-4bae-90fc-c426d30d22a8", + "name": "Get managed cluster's log configuration", + "request": { + "name": "Get managed cluster's log configuration", + "description": { + "content": "Get managed cluster's log configuration.", + "type": "text/plain" + }, + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f338a365-3bdf-4d10-ba8e-06984c944e7e", + "name": "Log configuration of ManagedCluster matching given cluster ID", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d879438-3090-4b7a-aa9a-c6771f5e1d65", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "85a85653-999e-460d-844c-d7f6990e5c9a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4ab7438d-c96a-4dd3-9b32-dd2921afbd9d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d177caf7-793a-4327-9405-65189cabc939", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "566a862f-1741-44c7-ad40-6671e4f50991", + "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": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa06497a-f981-4ea1-981c-cd931deff362", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "3bb70ed7-3d2d-4adb-bbd0-40c2b5fe7b4d", + "name": "Update managed cluster's log configuration", + "request": { + "name": "Update managed cluster's log configuration", + "description": { + "content": "Update managed cluster's log configuration", + "type": "text/plain" + }, + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6e647f1d-9cce-4615-aea4-a7eacccc93ca", + "name": "Responds with updated ClientLogConfiguration for given ManagedCluster", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dee4cd2b-1b8b-443e-80e6-34771257f7d4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7318581e-c05a-4985-b78d-e4c8a24d329b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7291605a-a4da-47a3-8629-bab6d79d5324", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "327b6191-b7a2-4dc5-9944-91af9e028113", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a656e48-d491-4683-a01e-cddc0999c6a4", + "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": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "163b498f-665b-4dee-9dda-080ed6e91f47", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters", + ":id", + "log-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"velit300\": \"INFO\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "id": "c615dfc5-b90e-4ad1-a1bf-a61d5f6cc75b", + "name": "Retrieve all Managed Clusters.", + "request": { + "name": "Retrieve all Managed Clusters.", + "description": { + "content": "Retrieve all Managed Clusters for the current Org, based on request context.", + "type": "text/plain" + }, + "url": { + "path": [ + "managed-clusters" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filtering is supported for the following fields and operators:\n\n**operational**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "89fb1a58-60e1-4b78-8c6f-1186cdf144bd", + "name": "Responds with a list of ManagedCluster.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filtering is supported for the following fields and operators:\n\n**operational**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"clientType\": \"CCG\",\n \"ccgVersion\": \"\",\n \"name\": \"\",\n \"pod\": \"\",\n \"org\": \"\",\n \"type\": \"idn\",\n \"configuration\": {\n \"in_35\": \"\",\n \"et2a\": \"\"\n },\n \"keyPair\": {\n \"publicKey\": \"\",\n \"publicKeyThumbprint\": \"\",\n \"publicKeyCertificate\": \"\"\n },\n \"attributes\": {\n \"queue\": {\n \"name\": \"\",\n \"region\": \"\"\n },\n \"keystore\": \"\"\n },\n \"description\": \"\",\n \"redis\": {\n \"redisHost\": \"\",\n \"redisPort\": \"\"\n },\n \"pinnedConfig\": false,\n \"logConfiguration\": {\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"incididunt5\": \"INFO\",\n \"esse_d\": \"INFO\"\n }\n },\n \"operational\": false,\n \"status\": \"\",\n \"publicKeyCertificate\": \"\",\n \"publicKeyThumbprint\": \"\",\n \"publicKey\": \"\",\n \"alertKey\": \"\",\n \"clientIds\": [\n \"\",\n \"\"\n ],\n \"serviceCount\": 0,\n \"ccId\": \"0\"\n },\n {\n \"id\": \"\",\n \"clientType\": \"INTERNAL\",\n \"ccgVersion\": \"\",\n \"name\": \"\",\n \"pod\": \"\",\n \"org\": \"\",\n \"type\": \"idn\",\n \"configuration\": {\n \"sunt_12\": \"\"\n },\n \"keyPair\": {\n \"publicKey\": \"\",\n \"publicKeyThumbprint\": \"\",\n \"publicKeyCertificate\": \"\"\n },\n \"attributes\": {\n \"queue\": {\n \"name\": \"\",\n \"region\": \"\"\n },\n \"keystore\": \"\"\n },\n \"description\": \"\",\n \"redis\": {\n \"redisHost\": \"\",\n \"redisPort\": \"\"\n },\n \"pinnedConfig\": false,\n \"logConfiguration\": {\n \"durationMinutes\": \"\",\n \"rootLevel\": \"INFO\",\n \"clientId\": \"\",\n \"expiration\": \"\",\n \"logLevels\": {\n \"tempor_ac\": \"INFO\",\n \"consequat7\": \"INFO\"\n }\n },\n \"operational\": false,\n \"status\": \"\",\n \"publicKeyCertificate\": \"\",\n \"publicKeyThumbprint\": \"\",\n \"publicKey\": \"\",\n \"alertKey\": \"\",\n \"clientIds\": [\n \"\",\n \"\"\n ],\n \"serviceCount\": 0,\n \"ccId\": \"0\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11d20d0f-2c46-41dd-a1b1-ca7365208198", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filtering is supported for the following fields and operators:\n\n**operational**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b02a2f54-7b59-4142-aaee-25485627247c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filtering is supported for the following fields and operators:\n\n**operational**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1151100-370a-4e65-a74a-2faff02c6351", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filtering is supported for the following fields and operators:\n\n**operational**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89ed69f9-b3f1-4880-af3f-c034a2aca5d2", + "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": { + "url": { + "path": [ + "managed-clusters" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filtering is supported for the following fields and operators:\n\n**operational**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e275fbbb-e7b5-413f-a8a7-8ccb737ae633", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "managed-clusters" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filtering is supported for the following fields and operators:\n\n**operational**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "mail-from-attributes", + "description": "", + "item": [ + { + "id": "18504de3-af31-40c4-b269-acf9c76e174b", + "name": "Change MAIL FROM domain", + "request": { + "name": "Change MAIL FROM domain", + "description": { + "content": "Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS", + "type": "text/plain" + }, + "url": { + "path": [ + "mail-from-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b4a8b223-ad3a-42c1-85b0-3f12c72cfcc2", + "name": "MAIL FROM Attributes required to verify the change", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\",\n \"mxRecord\": \"\",\n \"txtRecord\": \"\",\n \"mailFromDomainStatus\": \"SUCCESS\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4c178c4-b109-4a4b-aec7-d3e229ddcf66", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "669c1523-0ffe-480d-979c-edf321734234", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1811a5f-a1d1-4102-a4fd-2a890a82f2f5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45cad3d8-0d2f-4cae-b686-671a0a5373a8", + "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": { + "url": { + "path": [ + "mail-from-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae000326-4335-4fec-a0f4-d3a0dd49a0f1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{identity}", + "description": "", + "item": [ + { + "id": "dda5de4a-df7b-4abe-ab31-d26bb8b96236", + "name": "Get MAIL FROM Attributes", + "request": { + "name": "Get MAIL FROM Attributes", + "description": { + "content": "Retrieve MAIL FROM attributes for a given AWS SES identity.", + "type": "text/plain" + }, + "url": { + "path": [ + "mail-from-attributes", + ":identity" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status", + "type": "text/plain" + }, + "key": "id", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "key": "identity" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c9228b4a-8a7a-4d09-a548-ccac04f4f8fd", + "name": "MAIL FROM Attributes object", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes", + ":identity" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status", + "type": "text/plain" + }, + "key": "id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identity\": \"\",\n \"mailFromDomain\": \"\",\n \"mxRecord\": \"\",\n \"txtRecord\": \"\",\n \"mailFromDomainStatus\": \"SUCCESS\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa638d74-5104-44e8-83b3-aa4bc40f241b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes", + ":identity" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status", + "type": "text/plain" + }, + "key": "id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0b2f19a-417b-4658-968c-08d5aa0905ba", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes", + ":identity" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status", + "type": "text/plain" + }, + "key": "id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ac81f74-13dc-4fe7-8f0a-57b743ec81d6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes", + ":identity" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status", + "type": "text/plain" + }, + "key": "id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4cb0d979-3113-4ddc-b15e-83cb1b2a2702", + "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": { + "url": { + "path": [ + "mail-from-attributes", + ":identity" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status", + "type": "text/plain" + }, + "key": "id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a7cefff2-afb2-4a60-82de-092683468f43", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "mail-from-attributes", + ":identity" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status", + "type": "text/plain" + }, + "key": "id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "mfa", + "description": "", + "item": [ + { + "name": "{method}", + "description": "", + "item": [ + { + "name": "config", + "description": "", + "item": [ + { + "id": "46bb5258-d447-4607-ac94-579f55b9f9c5", + "name": "Configuration of a MFA method", + "request": { + "name": "Configuration of a MFA method", + "description": { + "content": "This API returns the configuration of a given MFA method. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "method", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d7e5513e-b7dc-4b27-82e8-ec0f478428a0", + "name": "MFA configuration of a given method.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c50a0b15-c950-475c-a77c-168ba974cec7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b41b803a-e57c-47be-9f6b-a31e4fbb5050", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "217e6a3e-84d1-4189-9ba0-715a67f90df0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed0d7cb3-a585-40bb-826c-728486a59d44", + "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": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d533587c-4934-4f29-97de-cb54309759cd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4ba43ba0-69a9-4519-abdb-9b255f684f9a", + "name": "Set MFA method configuration", + "request": { + "name": "Set MFA method configuration", + "description": { + "content": "This API sets the configuration of a given MFA method. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "method", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "732e8d50-ca8b-4eac-9115-b714601a0be6", + "name": "MFA configuration of a given method.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f02a96f4-2f9d-414f-9655-0843948efeaf", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b088562-acd3-49dd-a66b-da622a083c4e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c02177ba-186d-467c-a47d-47b411d95692", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f42567f4-9eb4-49d4-8ac9-bef2380a63b2", + "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": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7051947-ad73-429e-97ea-9802d0f6c16e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"host\": \"\",\n \"accessKey\": \"\",\n \"identityAttribute\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "test", + "description": "", + "item": [ + { + "id": "e78073b7-3e7d-426c-a1e4-e19754979ebd", + "name": "MFA method's test configuration", + "request": { + "name": "MFA method's test configuration", + "description": { + "content": "This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "mfa", + ":method", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "method", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "fe3bf61d-d375-4415-bdcd-3464a0e5084a", + "name": "The result of configuration test for the MFA provider.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"state\": \"FAILED\",\n \"error\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "56e99dd8-1f48-40f9-9ddd-379dc479d6d5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f551c146-fcf3-4016-8cdb-eabd2ff6393c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0bdef71a-645f-4dbb-9602-d7c63c14a450", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "921fd4d5-5662-4acf-8f0c-b287a0f45482", + "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": { + "url": { + "path": [ + "mfa", + ":method", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73a0fe15-6e9a-473c-a8a0-b07d17323505", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "mfa", + ":method", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "notification-template-defaults", + "description": "", + "item": [ + { + "id": "978026e2-b5a2-4c2f-9732-f8ece525ac95", + "name": "List Notification Template Defaults", + "request": { + "name": "List Notification Template Defaults", + "description": { + "content": "This lists the default templates used for notifications, such as emails from IdentityNow. Since this is a beta feature, it doesn't include all the templates.", + "type": "text/plain" + }, + "url": { + "path": [ + "notification-template-defaults" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "02aebfbb-9365-43a1-9030-fc5c374e44de", + "name": "A list of the default template objects", + "originalRequest": { + "url": { + "path": [ + "notification-template-defaults" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"key\": \"\",\n \"name\": \"\",\n \"medium\": \"TEAMS\",\n \"locale\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc0a8e43-1041-4587-90d5-24c3b6773a1c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "notification-template-defaults" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "696cccb8-316b-498a-8926-6a04f918a9c3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "notification-template-defaults" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "188244e7-3831-4b22-af06-631ccfde88bb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "notification-template-defaults" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0beaf227-9bda-4a41-a06d-6cb701e48938", + "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": { + "url": { + "path": [ + "notification-template-defaults" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4fa7460-8b12-4850-a693-5b77f1559550", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "notification-template-defaults" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "notification-templates", + "description": "", + "item": [ + { + "id": "656277e9-1486-40e4-b294-bfaf69bb1a97", + "name": "List Notification Templates", + "request": { + "name": "List Notification Templates", + "description": { + "content": "This lists the templates that you have modified for your site. Since this is a beta feature, it doesn't include all your modified templates.", + "type": "text/plain" + }, + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "fa1b165c-6f2d-4896-96d5-b4c1a6cccd31", + "name": "A list of template objects for your site", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "03bd9901-237d-4223-a42e-97b8641b2c51", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "54ed256c-b7e4-44ea-b9f2-eab5b3d16583", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9690e4d-86a1-4b88-869a-a59493d9e071", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "54691ca8-7467-4329-b0a4-06734beb1ae3", + "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": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5b84387-cbe3-4c1a-878c-5b24d03d805e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "67893e41-0dd6-416a-938d-541a42a0abb2", + "name": "Create Notification Template", + "request": { + "name": "Create Notification Template", + "description": { + "content": "This creates a template for your site. \n\nYou can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.", + "type": "text/plain" + }, + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7ed1460d-9184-4a02-8fcd-e4929385ad85", + "name": "A template object for your site", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"key\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "04c4a327-19a6-4caf-b6f2-ff9ad69bb48a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "330fc1fd-9ad3-488a-88e1-d78b313a950d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "08e3af2a-4577-49e5-a1c4-1ee8f3b78847", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c607f68c-a488-4a4a-bb00-8606441fb7ef", + "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": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b11c1d0f-f23e-4207-b88d-fc55d1da8733", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "notification-templates" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"EMAIL\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "cd1ac47e-e894-42e8-926b-f6fa04dd8387", + "name": "Get Notification Template By Id", + "request": { + "name": "Get Notification Template By Id", + "description": { + "content": "This gets a template that you have modified for your site by Id.", + "type": "text/plain" + }, + "url": { + "path": [ + "notification-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "187a5ecb-1c39-4615-ab19-84413876b496", + "name": "A template object for your site", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"locale\": \"\",\n \"name\": \"\",\n \"subject\": \"\",\n \"header\": \"\",\n \"body\": \"\",\n \"footer\": \"\",\n \"from\": \"\",\n \"replyTo\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3436740-bdc9-41a2-9416-0793f0e9835f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "56ad33ba-64b8-4ef2-b169-2d9b22c6974d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "249bc97f-c155-4a92-ba7d-e89609979914", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b864b3f5-0adf-4dcf-b0c3-6e2e7e8f2042", + "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": { + "url": { + "path": [ + "notification-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0fc5807-6143-4a15-b30f-25158ad0fdda", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "b7a98304-e6a0-441c-b9e7-2d738b1f1b22", + "name": "Bulk Delete Notification Templates", + "request": { + "name": "Bulk Delete Notification Templates", + "description": { + "content": "This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, you can only delete a subset of your notifications, i.e. ones that show up in the list call.", + "type": "text/plain" + }, + "url": { + "path": [ + "notification-templates", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d54fcbc3-d47c-4a0d-8d43-6d20a0adb1c3", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "9db2937f-1c34-410e-b311-c54f9df19e10", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96e07793-8258-4509-ad25-e41f171b7f2e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d262bcd0-f5eb-41e0-ac94-d62019c4fed4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab375b44-3efa-4f9a-a12b-6a9a81e9514b", + "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": { + "url": { + "path": [ + "notification-templates", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e8fc5b1c-487e-4fa7-a3c4-076c69f4bf61", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "notification-templates", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n },\n {\n \"key\": \"\",\n \"medium\": \"SMS\",\n \"locale\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "oauth-clients", + "description": "", + "item": [ + { + "id": "56797b79-72ea-4cbc-855f-66168193ec49", + "name": "List OAuth Clients", + "request": { + "name": "List OAuth Clients", + "description": { + "content": "This gets a list of OAuth clients.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4f7babdc-007b-4e05-b816-6bc797f2618a", + "name": "List of OAuth clients.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"CLIENT_CREDENTIALS\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n },\n {\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"AUTHORIZATION_CODE\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a4a5ba9-ddd1-477b-84ee-08ec7f471d1c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3df1af68-0702-4dc5-aec9-62143b0a4eb8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "85e8a93c-ff0a-4cbd-b5e5-2eb16068c9ca", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "15535a65-18c1-4e7f-9575-b5246da58ab6", + "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": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b09d5372-4b0a-414f-95d1-30bd30867511", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "aa8913a8-928f-4312-9da9-5097c2c37cbd", + "name": "Create OAuth Client", + "request": { + "name": "Create OAuth Client", + "description": { + "content": "This creates an OAuth client.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "cddbd800-d087-42fb-abb9-71dabc792219", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbbee52f-41fa-4363-bc0d-dabe5cd84466", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ee6331d-0f94-4fdf-a481-1990d19ffcaa", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42ab5a77-5aae-474f-b67d-6cff7162ef34", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b9f04789-ccd0-419c-947f-c548dc1a3ef1", + "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": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "963e5d06-a038-4789-a66c-ea7b695645a6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"REFRESH_TOKEN\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e16e5a52-a39f-4b34-9bb7-41ebcfc3eeeb", + "name": "Get OAuth Client", + "request": { + "name": "Get OAuth Client", + "description": { + "content": "This gets details of an OAuth client.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4867fa91-51eb-4ed6-8c58-57d933ca1afb", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20f00a43-634b-4f51-90b6-f7fa4213b9ed", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96688ecd-eaad-4dfb-82cd-9416c9965b70", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eda2a6de-3e64-4d09-92d3-fece7dfc243d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da4184ba-90fa-49ea-9cb4-7db2d80947bf", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33a81608-bb94-4c0e-8b03-cd446e16e927", + "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": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a9f7d17-c12a-44d9-9a5a-20a5cba58e30", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "7ab8c89c-34c0-4ffa-a112-12687590e217", + "name": "Delete OAuth Client", + "request": { + "name": "Delete OAuth Client", + "description": { + "content": "This deletes an OAuth client.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "b6de4cbc-4726-4d51-933d-909a4ef0b2bb", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "4d5521ae-fe0e-4051-a611-f077eeab69d6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "672212d0-48c0-434e-a862-82fb9d7fb74a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3f32aeba-d70b-4f91-bbe9-a8f025cc624d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8adc51f1-8262-4214-8e4c-fca2be970974", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2803df7-fb32-447f-be29-6b71994f26eb", + "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": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3cd944d-85cd-4e26-8569-d07d633b42c5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4786f05d-3f89-49da-ab19-b231435e9acb", + "name": "Patch OAuth Client", + "request": { + "name": "Patch OAuth Client", + "description": { + "content": "This performs a targeted update to the field(s) of an OAuth client.\nRequest will require a security scope of \n- sp:oauth-client:manage", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8d9ae448-b84a-4989-bf19-33f40c85acaf", + "name": "Indicates the PATCH operation succeeded, and returns the OAuth client's new representation.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "446811ca-70fb-48cd-8217-05210973dc45", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40b0e015-aca8-424f-bdcc-633c382d513d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5ed866a2-fb0b-4def-b015-a632dfe8b28a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e38a826d-ff84-4b5f-a084-a52535414289", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c4521b2-881f-4a8a-a34b-4a81d58a5c87", + "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": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cd47e1f3-3d5d-4573-9fcb-97b2f404a550", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "org-config", + "description": "", + "item": [ + { + "id": "f096308f-785f-4e02-9fce-2b2747cf9cb3", + "name": "Get Org configuration settings", + "request": { + "name": "Get Org configuration settings", + "description": { + "content": "Get org configuration with only external (org admin) accessible properties for the current org.", + "type": "text/plain" + }, + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ba1b8329-7087-4c72-9bc1-f9ceff0d561c", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"orgName\": \"\",\n \"timeZone\": \"\",\n \"lcsChangeHonorsSourceEnableFeature\": \"\",\n \"armCustomerId\": \"\",\n \"armSapSystemIdMappings\": \"\",\n \"armAuth\": \"\",\n \"armDb\": \"\",\n \"armSsoUrl\": \"\",\n \"iaiEnableCertificationRecommendations\": \"\",\n \"sodReportConfigs\": [\n {\n \"columnName\": \"\",\n \"required\": false,\n \"included\": false,\n \"order\": \"\"\n },\n {\n \"columnName\": \"\",\n \"required\": false,\n \"included\": false,\n \"order\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2e8c6ce-3b6b-4aa2-a7f8-815fb7e0100f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efd9a19a-6eb6-4bb5-8fe0-b64b3f77fb29", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "84040106-598b-48d5-8dcd-8103610b097f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a3184dff-a6bd-42e8-9798-d9f15584f3ad", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3aae5434-a525-4948-8d18-fde61690f835", + "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": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b54f738c-4df2-416a-a99b-374d35aeefba", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c709cc1d-1a02-4d4f-b0f3-2858e76cb8c8", + "name": "Patch an Org configuration property", + "request": { + "name": "Patch an Org configuration property", + "description": { + "content": "Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org.", + "type": "text/plain" + }, + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "46a2e771-16a4-4e1e-8ebf-3ee8baca9f85", + "name": "The Org was successfully patched.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"orgName\": \"\",\n \"timeZone\": \"\",\n \"lcsChangeHonorsSourceEnableFeature\": \"\",\n \"armCustomerId\": \"\",\n \"armSapSystemIdMappings\": \"\",\n \"armAuth\": \"\",\n \"armDb\": \"\",\n \"armSsoUrl\": \"\",\n \"iaiEnableCertificationRecommendations\": \"\",\n \"sodReportConfigs\": [\n {\n \"columnName\": \"\",\n \"required\": false,\n \"included\": false,\n \"order\": \"\"\n },\n {\n \"columnName\": \"\",\n \"required\": false,\n \"included\": false,\n \"order\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af07a8c9-e255-47f7-a95d-75cd0673c395", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec348a1d-18a8-46ad-aaec-4255826834b7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "88969eef-f6ed-4fda-b22e-61ecceb6da58", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0902e480-68b1-4ad4-9b26-36d63af35e5c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e4320904-15aa-4ea6-b1bc-793260e17cda", + "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": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "54994597-3ff0-4f0a-a851-79861571160d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "valid-time-zones", + "description": "", + "item": [ + { + "id": "1ca4f67d-9a83-4735-8325-36f4dead2581", + "name": "Get list of time zones", + "request": { + "name": "Get list of time zones", + "description": { + "content": "Get a list of valid time zones that can be set in org configurations.", + "type": "text/plain" + }, + "url": { + "path": [ + "org-config", + "valid-time-zones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "213a2f34-4a14-4306-bda5-bef150104702", + "name": "Request successful", + "originalRequest": { + "url": { + "path": [ + "org-config", + "valid-time-zones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n \"\",\n \"\"\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d0de146-03bd-48ed-81e0-774cfb0c27ec", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "org-config", + "valid-time-zones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0792d5e-8d71-4d11-9c4d-4229ab1c237c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "org-config", + "valid-time-zones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "777eb39e-cdc0-4f90-8af9-46a179fd24e1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "org-config", + "valid-time-zones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "08f0b980-db4c-449f-ae2c-661f123570ab", + "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": { + "url": { + "path": [ + "org-config", + "valid-time-zones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5f6f6e8-7e30-42fd-85d4-57f4f92ed952", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "org-config", + "valid-time-zones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "outlier-summaries", + "description": "", + "item": [ + { + "id": "cae7002a-a56c-487c-870b-75546a446353", + "name": "IAI Identity Outliers Summary", + "request": { + "name": "IAI Identity Outliers Summary", + "description": { + "content": "This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier\nRequires authorization scope of 'iai:outliers-management:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "outlier-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 field and operators: \n**snapshotDate**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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 field: **snapshotDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e8e5ca44-4985-45a7-96a4-e9c59fd323e9", + "name": "Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 field and operators: \n**snapshotDate**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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 field: **snapshotDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "The total result count.", + "type": "text/plain" + }, + "key": "X-Total-Count", + "value": "" + } + ], + "body": "[\n {\n \"type\": \"STRUCTURAL\",\n \"snapshotDate\": \"\",\n \"totalOutliers\": \"\",\n \"totalIdentities\": \"\"\n },\n {\n \"type\": \"LOW_SIMILARITY\",\n \"snapshotDate\": \"\",\n \"totalOutliers\": \"\",\n \"totalIdentities\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7101530e-de98-482b-bf1e-ebf4c931a195", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 field and operators: \n**snapshotDate**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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 field: **snapshotDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74662f4e-f079-4e6f-b7e9-7a2cc006267a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 field and operators: \n**snapshotDate**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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 field: **snapshotDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0fdde2d3-ed4e-4ece-99ed-801235cb7521", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 field and operators: \n**snapshotDate**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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 field: **snapshotDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4bed270-b1b3-4f19-8265-f69efb80a3f8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 field and operators: \n**snapshotDate**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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 field: **snapshotDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e61a612-0759-40b4-b6a1-4e2a81d76bbb", + "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": { + "url": { + "path": [ + "outlier-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 field and operators: \n**snapshotDate**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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 field: **snapshotDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63d9db3b-4b65-44bc-b8b3-fa311d7a65c5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 field and operators: \n**snapshotDate**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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 field: **snapshotDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "latest", + "description": "", + "item": [ + { + "id": "26f2db44-cc6f-4d06-b60c-25d7eb3a3876", + "name": "IAI Identity Outliers Latest Summary", + "request": { + "name": "IAI Identity Outliers Latest Summary", + "description": { + "content": "This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier\nRequires authorization scope of 'iai:outliers-management:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "outlier-summaries", + "latest" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1b2ec71e-5ae2-4d6b-a8a7-788e84af7c9e", + "name": "Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries", + "latest" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"type\": \"STRUCTURAL\",\n \"snapshotDate\": \"\",\n \"totalOutliers\": \"\",\n \"totalIdentities\": \"\",\n \"totalIgnored\": \"\"\n },\n {\n \"type\": \"LOW_SIMILARITY\",\n \"snapshotDate\": \"\",\n \"totalOutliers\": \"\",\n \"totalIdentities\": \"\",\n \"totalIgnored\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "612a2c12-ba1b-4e3c-a631-ce65d8f2a70a", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries", + "latest" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e8ddcf19-ca7a-4c11-83f0-04c986037cd9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries", + "latest" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aaa9ad87-e611-4d49-b369-1c84c42a38f7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries", + "latest" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e58f4980-d0f7-4e22-9214-f72ce325e0f4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries", + "latest" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42142fef-4cd0-436d-8058-2d760a4f2573", + "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": { + "url": { + "path": [ + "outlier-summaries", + "latest" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ac9fce9c-685c-47a1-8893-adf7dc6e16b9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outlier-summaries", + "latest" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "outliers", + "description": "", + "item": [ + { + "id": "0c603b67-a931-41d0-b281-845a466ff421", + "name": "IAI Get Identity Outliers", + "request": { + "name": "IAI Get Identity Outliers", + "description": { + "content": "This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information\nRequires authorization scope of 'iai:outliers-management:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **firstDetectionDate, attributes, score**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "58ef8bc2-c20d-45e9-8a46-3483e942ce2c", + "name": "Succeeded. Returns list of objects. Each object contains information about outliers", + "originalRequest": { + "url": { + "path": [ + "outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **firstDetectionDate, attributes, score**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "The total result count.", + "type": "text/plain" + }, + "key": "X-Total-Count", + "value": "" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"identityId\": \"\",\n \"type\": \"LOW_SIMILARITY\",\n \"firstDetectionDate\": \"\",\n \"latestDetectionDate\": \"\",\n \"ignored\": \"\",\n \"attributes\": {},\n \"score\": \"\",\n \"unignoreType\": \"AUTOMATIC\",\n \"unignoreDate\": \"\",\n \"ignoreDate\": \"\"\n },\n {\n \"id\": \"\",\n \"identityId\": \"\",\n \"type\": \"LOW_SIMILARITY\",\n \"firstDetectionDate\": \"\",\n \"latestDetectionDate\": \"\",\n \"ignored\": \"\",\n \"attributes\": {},\n \"score\": \"\",\n \"unignoreType\": \"MANUAL\",\n \"unignoreDate\": \"\",\n \"ignoreDate\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3fbfdac-ee82-4bd7-9d74-9a04c99c65f8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **firstDetectionDate, attributes, score**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef5ff4b2-bb8e-4d1b-9943-cbf9687a2c15", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **firstDetectionDate, attributes, score**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7bcf1674-2dbc-4a0c-91c8-de047a3c8127", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **firstDetectionDate, attributes, score**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f48505e7-2c62-4475-8c30-1ace7dc9c3d0", + "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": { + "url": { + "path": [ + "outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **firstDetectionDate, attributes, score**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89d8e625-32ae-48fa-ac30-8d91a45c3d09", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **firstDetectionDate, attributes, score**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{outlierId}", + "description": "", + "item": [ + { + "name": "contributing-features", + "description": "", + "item": [ + { + "id": "e36ac7dd-0cdf-4fe6-bb89-b4fbb12d503d", + "name": "Get identity outlier's contibuting features", + "request": { + "name": "Get identity outlier's contibuting features", + "description": { + "content": "This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object\nRequires authorization scope of 'iai:outliers-management:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "outliers", + ":outlierId", + "contributing-features" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Whether or not to include translation messages object in returned response", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **importance**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "outlierId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "7b0a4beb-4679-4d6d-a53a-ba423e6ccefa", + "name": "Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "contributing-features" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Whether or not to include translation messages object in returned response", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **importance**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "The total result count.", + "type": "text/plain" + }, + "key": "X-Total-Count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The locale to use for translations for displayName and description text", + "type": "text/plain" + }, + "key": "accept-language", + "value": "" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"valueType\": \"INTEGER\",\n \"value\": \"\",\n \"importance\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"translationMessages\": {\n \"displayName\": {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n \"description\": {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"valueType\": \"FLOAT\",\n \"value\": \"\",\n \"importance\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"translationMessages\": {\n \"displayName\": {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n \"description\": {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef38c99c-3fe1-4af3-8506-27992ac2b04a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "contributing-features" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Whether or not to include translation messages object in returned response", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **importance**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8325a719-5eac-4f17-a131-eb94066adcea", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "contributing-features" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Whether or not to include translation messages object in returned response", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **importance**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5ef9d461-8e4e-440b-9644-c984606d0196", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "contributing-features" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Whether or not to include translation messages object in returned response", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **importance**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e66beee7-ec76-4ff2-a858-d6746f64fdd2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "contributing-features" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Whether or not to include translation messages object in returned response", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **importance**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49dec1bb-7e49-41d8-9969-1716cecd3810", + "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": { + "url": { + "path": [ + "outliers", + ":outlierId", + "contributing-features" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Whether or not to include translation messages object in returned response", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **importance**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45544e28-67bb-4980-ad1b-47ff4409acb6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "contributing-features" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Whether or not to include translation messages object in returned response", + "type": "text/plain" + }, + "key": "include-translation-messages", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **importance**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "feature-details", + "description": "", + "item": [ + { + "name": "{contributingFeatureName}", + "description": "", + "item": [ + { + "name": "access-items", + "description": "", + "item": [ + { + "id": "93f783a4-e0fe-4152-ad9f-e5ac32df5962", + "name": "Gets a list of access items associated with each identity outlier contributing feature", + "request": { + "name": "Gets a list of access items associated with each identity outlier contributing feature", + "description": { + "content": "This API returns a list of the enriched access items associated with each feature filtered by the access item type The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare\nRequires authorization scope of 'iai:outliers-management:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "outliers", + ":outlierId", + "feature-details", + ":contributingFeatureName", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The type of access item for the identity outlier contributing feature. If not provided, it returns all", + "type": "text/plain" + }, + "key": "accessType", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **displayName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "outlierId", + "disabled": false + }, + { + "type": "any", + "value": "peerless_score", + "key": "contributingFeatureName", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8fa5c7bb-6c10-4faa-a248-801182618544", + "name": "The list of access items.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "feature-details", + ":contributingFeatureName", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The type of access item for the identity outlier contributing feature. If not provided, it returns all", + "type": "text/plain" + }, + "key": "accessType", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **displayName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"accessType\": \"ACCESS_PROFILE\",\n \"sourceName\": \"\",\n \"extremelyRare\": false\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"accessType\": \"ACCESS_PROFILE\",\n \"sourceName\": \"\",\n \"extremelyRare\": false\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a452b91-04b0-4200-90eb-0cfb805b52f4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "feature-details", + ":contributingFeatureName", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The type of access item for the identity outlier contributing feature. If not provided, it returns all", + "type": "text/plain" + }, + "key": "accessType", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **displayName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cd5489e9-b8a1-4909-a5a0-0740422e2df6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "feature-details", + ":contributingFeatureName", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The type of access item for the identity outlier contributing feature. If not provided, it returns all", + "type": "text/plain" + }, + "key": "accessType", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **displayName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4fd8635a-d203-4a36-891c-bb86c0885c7f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "feature-details", + ":contributingFeatureName", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The type of access item for the identity outlier contributing feature. If not provided, it returns all", + "type": "text/plain" + }, + "key": "accessType", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **displayName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ddc7dc54-dcc2-4cf4-adcc-3fc07d0c4850", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "feature-details", + ":contributingFeatureName", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The type of access item for the identity outlier contributing feature. If not provided, it returns all", + "type": "text/plain" + }, + "key": "accessType", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **displayName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc6931e1-5b07-4500-9980-1869cf278658", + "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": { + "url": { + "path": [ + "outliers", + ":outlierId", + "feature-details", + ":contributingFeatureName", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The type of access item for the identity outlier contributing feature. If not provided, it returns all", + "type": "text/plain" + }, + "key": "accessType", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **displayName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "86c7ae8d-b67c-4c0e-af60-b8ccd0b0b996", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outliers", + ":outlierId", + "feature-details", + ":contributingFeatureName", + "access-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "The type of access item for the identity outlier contributing feature. If not provided, it returns all", + "type": "text/plain" + }, + "key": "accessType", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **displayName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "ignore", + "description": "", + "item": [ + { + "id": "96e01a2e-52f4-4079-b1e7-6df91ec4b4ea", + "name": "IAI Identity Outliers Ignore", + "request": { + "name": "IAI Identity Outliers Ignore", + "description": { + "content": "This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful.\nRequires authorization scope of 'iai:outliers-management:update'", + "type": "text/plain" + }, + "url": { + "path": [ + "outliers", + "ignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "befa7b71-2195-4edd-959b-e8edc46296f7", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "ignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "7ba61ba9-e8f1-473c-be77-831e29b197c4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "ignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "86075110-c4d7-47c1-b890-f62d74f2b201", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "ignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dde89a6b-4f8d-477f-9ade-a7ad984bee0f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "ignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8eccb691-cbca-4adc-9e27-31723621dd34", + "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": { + "url": { + "path": [ + "outliers", + "ignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5960227-d308-4066-b0d2-73cf90b6dcf2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "ignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "unignore", + "description": "", + "item": [ + { + "id": "868cdcff-07a5-41a3-9184-e51de27c676e", + "name": "IAI Identity Outliers Unignore", + "request": { + "name": "IAI Identity Outliers Unignore", + "description": { + "content": "This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful.\nRequires authorization scope of 'iai:outliers-management:update'", + "type": "text/plain" + }, + "url": { + "path": [ + "outliers", + "unignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "5d4de8a0-47c5-4457-b0a0-c0653ddce5fb", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "unignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "79390cb2-df39-499f-8f38-82436dd37ab8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "unignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6355f3b-ee9c-4a0f-8570-a9ea2a5894fc", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "unignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "528c8099-fdc3-4fbd-9fc6-61cc6d9a78f6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "unignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "90be18a8-4182-4674-874f-0d25a27d412e", + "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": { + "url": { + "path": [ + "outliers", + "unignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2abd7ca2-5348-4bd9-bdcb-6c289bbef2cb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "unignore" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "export", + "description": "", + "item": [ + { + "id": "9e4c7546-f7bc-423b-90bd-7756597fd527", + "name": "IAI Identity Outliers Export", + "request": { + "name": "IAI Identity Outliers Export", + "description": { + "content": "This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes)\nRequires authorization scope of 'iai:outliers-management:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "outliers", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "7247de53-87d7-4fdf-b730-193fc70f3220", + "name": "Succeeded. Returns zip of 2 CSVs to download. 1 CSV for ignored outliers and 1 for non-ignored outliers", + "originalRequest": { + "url": { + "path": [ + "outliers", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "813e216b-2b72-4d34-8337-d8b9979b37b1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "768f53c6-c22f-47ed-b6c1-f9b64dd628a4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b3c83ba-7a08-4f38-bd61-8da703d3af67", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "39b47d06-eddd-4667-8bb4-0475b4390b7f", + "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": { + "url": { + "path": [ + "outliers", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b13146ab-b523-47c0-93b0-4f21f2738eec", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outliers", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Type of the identity outliers snapshot to filter on", + "type": "text/plain" + }, + "key": "type", + "value": "LOW_SIMILARITY" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "outlier-feature-summaries", + "description": "", + "item": [ + { + "name": "{outlierFeatureId}", + "description": "", + "item": [ + { + "id": "19f2cae8-79b9-4fed-8886-1a6a7304dbb2", + "name": "Get identity outlier contibuting feature summary", + "request": { + "name": "Get identity outlier contibuting feature summary", + "description": { + "content": "This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object\nRequires authorization scope of 'iai:outliers-management:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "outlier-feature-summaries", + ":outlierFeatureId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "outlierFeatureId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "86a4e346-f477-435a-a4d2-ae6d1dd5952d", + "name": "Succeeded. Returns selected contributing feature summary for an outlier", + "originalRequest": { + "url": { + "path": [ + "outlier-feature-summaries", + ":outlierFeatureId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "The locale to use for translations", + "type": "text/plain" + }, + "key": "accept-language", + "value": "" + } + ], + "body": "{\n \"contributingFeatureName\": \"\",\n \"identityOutlierDisplayName\": \"\",\n \"outlierFeatureDisplayValues\": [\n {\n \"displayName\": \"\",\n \"value\": \"\",\n \"valueType\": \"FLOAT\"\n },\n {\n \"displayName\": \"\",\n \"value\": \"\",\n \"valueType\": \"FLOAT\"\n }\n ],\n \"featureDefinition\": \"\",\n \"featureExplanation\": \"\",\n \"peerDisplayName\": \"\",\n \"peerIdentityId\": \"\",\n \"accessItemReference\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31462cfe-481a-4816-abee-45fcd7e8b295", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "outlier-feature-summaries", + ":outlierFeatureId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "05ca53f3-e60d-405c-9a30-7e6d3de4a643", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "outlier-feature-summaries", + ":outlierFeatureId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ad106b6-5b9f-4eb1-91b5-e0c628a665e8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "outlier-feature-summaries", + ":outlierFeatureId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc551709-1410-4c0f-a21e-420bcf8cc075", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "outlier-feature-summaries", + ":outlierFeatureId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "365c3d8d-f32d-4f41-be18-9ea6bdb1f918", + "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": { + "url": { + "path": [ + "outlier-feature-summaries", + ":outlierFeatureId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fee77c2e-802e-4c08-8cbe-0c877094266d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "outlier-feature-summaries", + ":outlierFeatureId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "password-dictionary", + "description": "", + "item": [ + { + "id": "0e0f7f82-879a-4b90-8065-498e3930684b", + "name": "Get Password Dictionary", + "request": { + "name": "Get Password Dictionary", + "description": { + "content": "This gets password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/plain" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3dd2e367-2110-491c-b2c1-372cf3d04e97", + "name": "\nThe password dictionary file can contain lines that are:\n1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing\n2. empty lines\n3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines\n4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;\n maximum length of the line is 128 Unicode codepoints\n\n\nPassword dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).\n Password dict file must contain UTF-8 characters only.\n\n# Sample password text file\n\n```\n\n# Password dictionary small test file\n\nlocale=en_US\n\n# Password dictionary prohibited words\n\nqwerty\nabcd\naaaaa\npassword\nqazxsws\n\n```", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/plain" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "09d3b015-9b0e-4a69-93d3-cdef863d4f78", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "83abea5c-08de-4a7c-975d-19b8e099b020", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1234b1b8-1c05-4cfe-89f5-a24ca6ea2e0d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2304bbe-b081-4dd0-b680-b4467423f4f6", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4d333bc-6bbd-47fe-b7bf-a86186eed793", + "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": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "44c50a32-d640-4e7f-a78a-263e5092c19c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5779da6c-49f6-4b30-b3f3-33fe61d4c4f4", + "name": "Update Password Dictionary", + "request": { + "name": "Update Password Dictionary", + "description": { + "content": "This updates password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "f3006d4f-fa67-417d-be43-dcb9697a6a80", + "name": "Successfully updated.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "72748dab-4ada-46ac-8cc3-f76213868e7a", + "name": "Created.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Created", + "code": 201, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "674ffd24-1eb5-45ac-8bdf-fef02b403d32", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7bc6dbe0-f354-4c13-bd9e-cf30e4748876", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "480223cc-a56d-4e4d-82f4-a2e6a5d8c396", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32f9db06-c3e3-4cc1-9356-16423bf77b14", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7815007b-6222-4e54-a0a0-cc3a35ef6d61", + "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": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "85b6fde2-53c1-4a14-bdd0-65542bfb375a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "query-password-info", + "description": "", + "item": [ + { + "id": "eee739c5-ff85-4048-a479-f57479a4804a", + "name": "Query Password Info", + "request": { + "name": "Query Password Info", + "description": { + "content": "This API is used to query password related information. \n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) \nis required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" \ngrant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) \nor a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) \ngrant type will **NOT** work on this endpoint, and a `403 Forbidden` response \nwill be returned.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "df358828-7cc9-48ab-9b56-8b4bb7ef9de8", + "name": "Reference to the password info.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identityId\": \"\",\n \"sourceId\": \"\",\n \"publicKeyId\": \"\",\n \"publicKey\": \"\",\n \"accounts\": [\n {\n \"accountId\": \"\",\n \"accountName\": \"\"\n },\n {\n \"accountId\": \"\",\n \"accountName\": \"\"\n }\n ],\n \"policies\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42892e27-5959-4051-91db-a5686dce0839", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4fdbbfff-d618-472e-a9c1-4cff9526fbb3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e7e2ed30-2c5e-4104-be83-a9a520211ac2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3d1993fe-3f13-46de-8bb0-e77d819fba5a", + "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": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc8056e6-6dab-4583-8d9c-949ea6067a2f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "set-password", + "description": "", + "item": [ + { + "id": "71cc0a48-c5da-4e67-8e88-a966ac8017d5", + "name": "Set Identity's Password", + "request": { + "name": "Set Identity's Password", + "description": { + "content": "This API is used to set a password for an identity. \n\nAn identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).\n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. \n\"API authority\" refers to a token that only has the \"client_credentials\" grant type.\n\nYou can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). \nTo do so, follow these steps:\n\n1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. \n\n2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. \n\n3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password:\n\n```java\nimport javax.crypto.Cipher;\nimport java.security.KeyFactory;\nimport java.security.PublicKey;\nimport java.security.spec.X509EncodedKeySpec;\nimport java util.Base64;\n\nString encrypt(String publicKey, String toEncrypt) throws Exception {\n byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey);\n byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\"));\n return Base64.getEncoder().encodeToString(encryptedBytes);\n}\n\nprivate byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception {\n PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes));\n String transformation = \"RSA/ECB/PKCS1Padding\";\n Cipher cipher = Cipher.getInstance(transformation);\n cipher.init(1, key);\n return cipher.doFinal(toEncryptBytes);\n}\n``` \n\nIn this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. \n\nYou can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. \n", + "type": "text/plain" + }, + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ad43b64e-2800-4c1c-a38f-9642f79b2ddf", + "name": "Reference to the password change.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"requestId\": \"\",\n \"state\": \"FINISHED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2d80b8f-44d5-4a33-aea5-aa34b0a0dba8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "514f5e67-c2d0-410d-a504-a079c7520f52", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea9d3a10-d4eb-4874-9261-6b6d601c357e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da0e78cc-6811-4f99-af91-139ca4906197", + "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": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5041da7b-396b-4108-8f7c-b60b62e79078", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "password-change-status", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "7cc6b62b-3dc7-4cc2-be97-d0d3cb4ba831", + "name": "Get Password Change Request Status", + "request": { + "name": "Get Password Change Request Status", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f80fd087-1b8e-4489-b918-57d10babbe48", + "name": "Status of the password change request", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"requestId\": \"\",\n \"state\": \"FAILED\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d683428-eabe-46f2-a9d7-2487dae41eda", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e14c1d0f-4c22-4c99-bac3-19800a1c5676", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9e5dc376-925d-47b8-bf24-4162c4ea00a5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cb81f11-21d5-4fef-9867-f82e4cbc77ca", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec54d98e-1067-4f96-baf5-8015110aec93", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "password-sync-groups", + "description": "", + "item": [ + { + "id": "e04c38eb-3571-48f1-9a72-a5fe25a64ced", + "name": "Get Password Sync Group List", + "request": { + "name": "Get Password Sync Group List", + "description": { + "content": "This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e588eb7c-300c-449f-93eb-6f9548836015", + "name": "A list of password sync groups.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e02bbb5b-6483-4596-9aed-55d3e0a7c78e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ee1ff763-f6a7-49fa-9310-33a43c233832", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a9c815b8-bbaa-484a-aa2b-6aa2e38b4dce", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0d5c8c23-beba-4721-b94d-ae09d59624be", + "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": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f58b81f-3433-42ed-abda-f77bb8fca842", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a9a5b90f-86d4-47b3-bafc-09ae71c3040e", + "name": "Create Password Sync Group", + "request": { + "name": "Create Password Sync Group", + "description": { + "content": "This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "195c27dd-3f88-4268-a628-b493a2121318", + "name": "Reference to the password sync group.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97c607d8-e75e-4069-9fec-479a6ef93d11", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "841f14e7-0038-4bad-b3ed-870961d2fc02", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c9a2a82c-c839-4fb8-ba9f-e82dbef23241", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24de6f0b-84da-4b63-87de-d6bc28d20b67", + "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": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "27fd35e4-bf44-49e4-ae1e-4cac0d25cbce", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "76cdb4f7-159c-4305-b1bf-d7b34358f392", + "name": "Get Password Sync Group by ID", + "request": { + "name": "Get Password Sync Group by ID", + "description": { + "content": "This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "be54a4a4-6dcd-4a72-8d74-69ebc8ef5349", + "name": "Reference to the password sync group.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ee61ef55-1e7e-4ca0-a1cc-4eb249183305", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13466c9d-11c9-42fb-ae85-d73b9a2b235c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "744efc94-1f12-4a57-a51d-cc11100827ab", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "14c12a1f-5cd5-41d8-ab3a-084c3256c389", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1101daa-582a-4ddc-b34c-68184797f95b", + "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": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "459c0a97-b954-42f3-bf64-b2a0ae7bf252", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "09fcdd1f-861b-4a7e-85f1-8d4ea213db7e", + "name": "Update Password Sync Group by ID", + "request": { + "name": "Update Password Sync Group by ID", + "description": { + "content": "This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d78dce89-4fe9-4fe4-9531-db00da87f952", + "name": "Reference to the password sync group.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fdb81675-6211-4e33-82da-49b4fcdc225f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4c173d6-dbc8-4fd4-b8b0-b86619c6f397", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "254bd1b0-f109-49e6-a9ce-1092adf005ae", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3146b8aa-3f43-4670-bc7c-227f35bf4ca7", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9dfb6671-0da6-40f5-8993-f462793d0e6d", + "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": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc5f3963-a32f-44a6-a89e-0100d6f11d1b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "659cd43b-13da-4399-88ec-6b4ed56cbfef", + "name": "Delete Password Sync Group by ID", + "request": { + "name": "Delete Password Sync Group by ID", + "description": { + "content": "This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "7237c9bf-cc81-4722-b4e1-42b37c072e78", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "e59fecc8-389d-482c-a7b5-908b9da7a441", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "27920cae-ac04-4714-9203-53f59cb81caf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a858a2a3-9dc3-4c58-b3c5-8981634e3c55", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c3473fa-6594-4edb-8276-e8e95670e1fb", + "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": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1ee645af-0dd2-4403-b9f8-8677cfc2a1e7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "password-org-config", + "description": "", + "item": [ + { + "id": "12bf00f3-6995-4671-b667-234c421b1818", + "name": "Get Password Org Config", + "request": { + "name": "Get Password Org Config", + "description": { + "content": "This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "cd6d0513-6c8f-43a7-8076-863f7788c426", + "name": "Reference to the password org config.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45803dd0-f04d-4a7a-b1aa-ac5105887cbc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c454923-3c9d-4e09-a0cf-50c52814785b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0fbd1fac-102c-40d3-a3ca-392b343a1f51", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3cc33dad-0555-404f-851d-5584e44ee83a", + "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": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f274cd80-ac95-4563-8b45-1866d40bd2c2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "aabdf7f0-d6a8-41b3-8d00-426303ff063e", + "name": "Update Password Org Config", + "request": { + "name": "Update Password Org Config", + "description": { + "content": "This API updates the password org config for specified fields. Other fields will keep original value.\nYou must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. \nRequires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'", + "type": "text/plain" + }, + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "87a51515-ba87-47bc-998d-bc67363c721b", + "name": "Reference to the password org config.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "defbbad4-f981-4fdc-a9fe-91647998ac86", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f86b2b79-4355-496f-ba78-db53e8d18a6c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2e9092d-0c77-4465-b981-47561a3c5480", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c21d0dd4-e235-440d-9f6d-681ad4753b0e", + "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": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f524105f-d65b-43d5-8b95-4f1d9e5d4a14", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "26474824-9644-4fbd-a9ec-3454a28cd97f", + "name": "Create Password Org Config", + "request": { + "name": "Create Password Org Config", + "description": { + "content": "This API creates the password org config. Unspecified fields will use default value.\nTo be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\".\nRequires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'", + "type": "text/plain" + }, + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1575c542-f37d-4a48-803e-737c5f21813c", + "name": "Reference to the password org config.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31a49312-31c5-4824-8916-aedc646860f4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35c4365d-cde4-4665-a9b7-bb3ea4926170", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8fea08db-fa12-48a3-84d9-701e05b9c561", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a60374a-eebc-4343-98b2-e84efa9fa025", + "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": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf85dbf8-4805-4591-8801-8a0619a212ae", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "peer-group-strategies", + "description": "", + "item": [ + { + "name": "{strategy}", + "description": "", + "item": [ + { + "name": "identity-outliers", + "description": "", + "item": [ + { + "id": "8c273b15-d4c7-4c02-a95f-a6fe8764752b", + "name": "Identity Outliers List", + "request": { + "name": "Identity Outliers List", + "description": { + "content": "-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned.", + "type": "text/plain" + }, + "url": { + "path": [ + "peer-group-strategies", + ":strategy", + "identity-outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "strategy", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "da16f235-2025-483f-8a47-e22d7238c6cd", + "name": "List of identities that are not included in peer groups.", + "originalRequest": { + "url": { + "path": [ + "peer-group-strategies", + ":strategy", + "identity-outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"type\": \"\",\n \"peer_group_id\": \"\",\n \"attributes\": {\n \"irure2d\": {},\n \"cupidatat_d\": {},\n \"ipsum2\": {}\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"peer_group_id\": \"\",\n \"attributes\": {\n \"magna22\": {}\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc964abc-0297-4735-9afc-9eebaecd37ac", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "peer-group-strategies", + ":strategy", + "identity-outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b38139e2-de90-460d-a82d-dd6cb3072414", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "peer-group-strategies", + ":strategy", + "identity-outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "58d6aae7-fa55-495c-85d2-f3a364e84511", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "peer-group-strategies", + ":strategy", + "identity-outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26329e37-9092-46c4-9dce-f49138b05f5d", + "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": { + "url": { + "path": [ + "peer-group-strategies", + ":strategy", + "identity-outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "646cfc78-19dd-4837-a908-0f9ee3703688", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "peer-group-strategies", + ":strategy", + "identity-outliers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "personal-access-tokens", + "description": "", + "item": [ + { + "id": "a97494fb-9d47-4fba-a747-69021ad6758d", + "name": "List Personal Access Tokens", + "request": { + "name": "List Personal Access Tokens", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9e44e36f-4667-45f7-b2d1-94f4cc2834f4", + "name": "List of personal access tokens.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35ccd9d7-7a1d-45da-9f38-d193b41da5d2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1795df26-6c97-485a-9816-77e9d7ba6c76", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2972e09d-4af3-48d1-8310-f08a9a166812", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae941014-140b-4d6a-a6c5-81403369664d", + "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": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa0fecd6-804e-45b7-8a6f-fea8702a9525", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ac61fa37-435b-4575-913d-26bf872c6526", + "name": "Create Personal Access Token", + "request": { + "name": "Create Personal Access Token", + "description": { + "content": "This creates a personal access token.", + "type": "text/plain" + }, + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "0d28c28d-57ff-4e28-a226-08d4bbcc5e6b", + "name": "Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"name\": \"\",\n \"owner\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc655ac7-a8a0-4606-9a2e-7d5376f3e4f7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "de612f08-4d84-448a-a956-6324aac7b1c9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5095fbb8-8f0d-463c-b379-c9372f70e9af", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33f7ab52-8cdd-4f2b-b37f-54a99e115c34", + "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": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "331d2110-2c8e-413c-a59f-9aa5499442de", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e5242af8-c433-47ed-b0d0-3dda5de785cd", + "name": "Patch Personal Access Token", + "request": { + "name": "Patch Personal Access Token", + "description": { + "content": "This performs a targeted update to the field(s) of a Personal Access Token.", + "type": "text/plain" + }, + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "49258787-57d1-43d3-9072-e0ac0317b49c", + "name": "Indicates the PATCH operation succeeded, and returns the PAT's new representation.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa806a55-b898-48f9-af20-3d735a8cbbbb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d28361a4-b8ce-461a-bfc0-a4aae3413d08", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74d5093a-9918-4ca1-b17d-93f484d56e04", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ceedd0ca-df78-4c27-a456-6f02746d41ae", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9d227fc2-054c-457d-ae77-1078cde18884", + "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": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a0dc3a46-d067-4951-b58c-72d3b9e75f0d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "60b7762f-b1bd-41ee-8c5a-556d1c90da55", + "name": "Delete Personal Access Token", + "request": { + "name": "Delete Personal Access Token", + "description": { + "content": "This deletes a personal access token.", + "type": "text/plain" + }, + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "75fddf1d-a8f1-4134-882f-c106bda02ba5", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "71bbb051-bc49-4122-87b4-a03f0aab0e09", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea720258-6bc6-4402-9feb-e74a67731f41", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e4c494b-cff4-4910-bf7e-d91e103fb334", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "10cae4f6-d261-4d76-8b61-ac43422efb01", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "39674616-2ea5-414e-849d-ad602cf8edfd", + "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": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57faa0f1-0b3a-4b65-9993-530a1521fe01", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "public-identities-config", + "description": "", + "item": [ + { + "id": "4c741486-f981-4802-a28a-c225479f09b4", + "name": "Get Public Identity Config", + "request": { + "name": "Get Public Identity Config", + "description": { + "content": "This gets details of public identity config.", + "type": "text/plain" + }, + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "daf4fa5c-55a7-4107-b4e8-948142325795", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a615bc5-5a9e-4f65-af2a-ed5470896fd9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11e56ae3-d23b-4da2-8927-860cd590514e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33beb65e-ee71-4ddb-9969-878f1fadd3d7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e6859ba-ec6c-4cec-9ebb-1dfc0092028d", + "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": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "990e215f-1b7d-4d38-b2e4-47e73ccb38a0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f3a741bb-69d4-45d0-8320-9cff49841c86", + "name": "Update Public Identity Config", + "request": { + "name": "Update Public Identity Config", + "description": { + "content": "This updates the details of public identity config.", + "type": "text/plain" + }, + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "04a7200e-f1a7-4e32-90a9-85cea463a2e9", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a733cd7-c7ad-4995-a16c-e726c9edb702", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "952c7624-74aa-4865-b84e-98b24d10d093", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c99d4ce-2060-4930-b538-3c568f4120b9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "92a41628-9f46-46ee-8b24-cf60fe826319", + "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": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d4a94a7-2f4e-439b-a341-e4bc523dbccf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modifiedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "notification-template-context", + "description": "", + "item": [ + { + "id": "21c9eac6-8a93-4d60-b5f8-baf725cb5d3f", + "name": "Get Notification Template Context", + "request": { + "name": "Get Notification Template Context", + "description": { + "content": "The notification service (Hermes) maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes\n that will be available per tenant (organization).\n\nRegarding authorization, the access token contains the tenant and will grant access to the one requested.\nRequires the following security scope: idn:notification-templates:read", + "type": "text/plain" + }, + "url": { + "path": [ + "notification-template-context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c1a9c4e0-f985-4aa6-9188-57219811a654", + "name": "Notification template context attributes for a specific tenant.", + "originalRequest": { + "url": { + "path": [ + "notification-template-context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"attributes\": {},\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"attributes\": {},\n \"created\": \"\",\n \"modified\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "07ec4471-5a22-4c80-ba30-38002808861f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "notification-template-context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4075a67-4800-4293-b5f2-3c4676f79d8b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "notification-template-context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "599f3912-19f0-4723-b225-daed3d8742a9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "notification-template-context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa07e91e-a037-4f58-8cb6-eda50698f722", + "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": { + "url": { + "path": [ + "notification-template-context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0eac3a76-3fa1-410d-b0ca-2a10962e1f88", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "notification-template-context" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "notification-preferences", + "description": "", + "item": [ + { + "name": "{key}", + "description": "", + "item": [ + { + "id": "58c03689-3667-4493-9e01-55b1840229b5", + "name": "Get Notification Preferences for tenant.", + "request": { + "name": "Get Notification Preferences for tenant.", + "description": { + "content": "Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned.\nRequest will require the following legacy roles: ORG_ADMIN and API", + "type": "text/plain" + }, + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "key", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "848d850a-bcb4-412b-85b0-c6d672500aaa", + "name": "Return preference for the given notification key.", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6364a973-193a-4ea7-a20f-1331efdf5d9e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a6d879b-b89b-4751-af7f-b54a2c8ca52e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a019e127-f4f7-4d32-b13b-797f01c1addc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a3f23ea-ede2-4b24-8829-2e7195e04fe4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2659d12-5513-4052-9481-ffc0a579445f", + "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": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9203a2dd-5ab2-492e-9dcf-69d9e6a7de94", + "name": "Overwrite the preferences for the given notification key.", + "request": { + "name": "Overwrite the preferences for the given notification key.", + "description": { + "content": "In the notification world, a notification flows through these salient stages - \n 1. Interest matching, \n 2. Preferences \n 3. Template Rendering. \n\nThe default notification preferences make up a part of the second stage, along with user preferences (which is a future goal). The expectation is for admins to be able to set default preferences for their org, like opting in to or out of certain notifications, and configuring future preferences as we tack on more features. The key in the Dto is not necessary but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. \nRequest will require the following legacy roles: ORG_ADMIN and API", + "type": "text/plain" + }, + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "key", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "94dc563e-0aab-4045-b387-13d6ffe79570", + "name": "The preferences were successfully replaced, and an echo of the new preferences are sent back to caller.", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef9f2124-edcf-476a-b8df-d78f6a9732b4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e96585f-a26d-4e53-a55d-2375137af7e9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "41dffa61-2a28-4438-bd28-dcb207d667fc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9fbb2f7f-34e6-43a9-8bbe-a5cdc2faf32f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7db423b3-6381-405f-b012-98ece7fe69c2", + "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": { + "url": { + "path": [ + "notification-preferences", + ":key" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"mediums\": [\n \"SLACK\",\n \"PHONE\"\n ],\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "reassignment-configurations", + "description": "", + "item": [ + { + "name": "types", + "description": "", + "item": [ + { + "id": "87808715-b879-485f-ab22-b5f77b624b0c", + "name": "List Reassignment Config Types", + "request": { + "name": "List Reassignment Config Types", + "description": { + "content": "Gets a collection of types which are available in the Reassignment Configuration UI.", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "880bb254-d8ad-4c6f-bcab-c1aadb463c89", + "name": "List of Reassignment Configuration Types", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"internalName\": \"CERTIFICATIONS\",\n \"displayName\": \"\",\n \"description\": \"\"\n },\n {\n \"internalName\": \"ACCESS_REQUESTS\",\n \"displayName\": \"\",\n \"description\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb639f77-1fe8-48da-a3c9-ab6e2ba69571", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26bd06a0-7a73-4dbe-a9c7-03c7a525a91a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fbd1c19e-2fa7-479e-a23c-b24e127dd5b6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a5d6513-8b54-47e7-96f8-66819ed19f71", + "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": { + "url": { + "path": [ + "reassignment-configurations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6beedce0-56b6-40b8-9add-9c37ba373a36", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "id": "f65a97d3-84a1-4b77-bf72-b66f5485d44a", + "name": "List Reassignment Configurations", + "request": { + "name": "List Reassignment Configurations", + "description": { + "content": "Gets all Reassignment configuration for the current org.", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e9c45706-3825-4b5d-ad02-a1ce69b310ba", + "name": "A list of Reassignment Configurations for an org", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"identity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"configDetails\": [\n {\n \"configType\": \"ACCESS_REQUESTS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n {\n \"configType\": \"MANUAL_TASKS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n ]\n },\n {\n \"identity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"configDetails\": [\n {\n \"configType\": \"ACCESS_REQUESTS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n {\n \"configType\": \"CERTIFICATIONS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fea9f4fb-3d80-4d84-9abd-ac0a5847de1f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b5124a6e-9704-4d7e-8438-9a5784fcd76f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89b2a1af-35ae-4ff6-8ff1-a79ffc58cb63", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da60609d-3bbd-4d9d-94a3-5fd39d3e31bd", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0862612f-87db-46cc-915c-1bd64dbad6f5", + "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": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95fe0199-250b-41fa-94b0-01052dffc5c4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "47118fbf-c3cd-420e-8bcc-f8d18fba1c14", + "name": "Create a Reassignment Configuration", + "request": { + "name": "Create a Reassignment Configuration", + "description": { + "content": "Creates a new Reassignment Configuration for the specified identity.", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "5ae5c4c1-1c55-471c-ad51-b4f9b3d18989", + "name": "The newly created Reassignment Configuration object", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"configDetails\": [\n {\n \"configType\": \"CERTIFICATIONS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n {\n \"configType\": \"ACCESS_REQUESTS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34018e50-7488-4dce-af31-e5edd5c35ac2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "953404cf-0225-41ec-9fdc-d9ec8d5ea162", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb21267b-ceef-4a81-9ce2-4d5050149f7b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4b8e083-3924-4387-b70d-d59066cb4d1a", + "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": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "984c9b5b-fe20-4b2f-93d0-bd3edaf78494", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{identityId}", + "description": "", + "item": [ + { + "id": "d4bb3a50-1e3c-4e67-beff-f92a25f2ea81", + "name": "Get Reassignment Configuration", + "request": { + "name": "Get Reassignment Configuration", + "description": { + "content": "Gets the Reassignment Configuration for an identity.", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identityId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5f78109b-0e92-42c0-bf26-24ed6b57b9ee", + "name": "Reassignment Configuration for an identity", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"configDetails\": [\n {\n \"configType\": \"CERTIFICATIONS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n {\n \"configType\": \"ACCESS_REQUESTS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bcd434d4-8b72-4ee0-8c6d-a243c02d6f24", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5d3e2d6-de26-45da-920f-1bb415024e84", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a33d5af-361c-4bcd-a3bf-485faff43782", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99a9974c-fecf-4d0d-b4b4-740f9a39a918", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "25022a76-a40d-49dd-bfcb-34b55cfaeee4", + "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": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa30cede-8943-4d90-9a45-ceb99e10293c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d7cbd1e6-0fd0-4719-a892-07d9d6c122c0", + "name": "Update Reassignment Configuration", + "request": { + "name": "Update Reassignment Configuration", + "description": { + "content": "Replaces existing Reassignment configuration for an identity with the newly provided configuration.", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identityId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ba53dde4-49e5-465d-810e-74ebe24f4e5a", + "name": "Reassignment Configuration updated", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"configDetails\": [\n {\n \"configType\": \"CERTIFICATIONS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n {\n \"configType\": \"ACCESS_REQUESTS\",\n \"targetIdentity\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "228569ba-27bb-4789-bb57-1499e8272c10", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0b915b1-23c7-4e97-9365-6d486f566900", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "92aff713-ef51-4309-a028-56a8cff00b63", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ccd53488-9a18-4c4f-aac0-6aa1e471f5c5", + "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": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c63902a0-ea70-4cd6-b808-a998ad9c0ce3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"reassignedFromId\": \"\",\n \"reassignedToId\": \"\",\n \"configType\": \"CERTIFICATIONS\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b36b71a5-4d3a-48e2-8ae0-cf7434ba5359", + "name": "Delete Reassignment Configuration", + "request": { + "name": "Delete Reassignment Configuration", + "description": { + "content": "Deletes all Reassignment Configuration for the specified identity", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identityId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "299126e2-5c57-4b71-9b28-b18bc0f8a5c0", + "name": "Reassignment Configuration deleted", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "d4833aa1-706b-4d02-bfba-0b6b250ffb40", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec811bf7-ab75-4abd-9ede-19d37c4adf39", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3cb48b35-f742-4447-b85c-0387d59bf208", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "71a34058-7ff5-4660-9451-cac7b96fcd31", + "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": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "daa8a056-f15f-4a98-a760-00552603da31", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "evaluate", + "description": "", + "item": [ + { + "name": "{configType}", + "description": "", + "item": [ + { + "id": "259bd35a-ff6b-4c9f-bff1-60a481e80b58", + "name": "Evaluate Reassignment Configuration", + "request": { + "name": "Evaluate Reassignment Configuration", + "description": { + "content": "Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty.", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations", + ":identityId", + "evaluate", + ":configType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments", + "type": "text/plain" + }, + "key": "exclusionFilters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments", + "type": "text/plain" + }, + "key": "exclusionFilters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "identityId", + "disabled": false + }, + { + "type": "any", + "value": "CERTIFICATIONS", + "key": "configType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ad9fc744-0f06-468e-90cd-dbc45af30480", + "name": "Evaluated Reassignment Configuration", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId", + "evaluate", + ":configType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments", + "type": "text/plain" + }, + "key": "exclusionFilters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"reassignToId\": \"\",\n \"lookupTrail\": [\n {\n \"reassignedToId\": \"\",\n \"reassignedFromId\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT,\"\n },\n {\n \"reassignedToId\": \"\",\n \"reassignedFromId\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT,\"\n }\n ]\n },\n {\n \"reassignToId\": \"\",\n \"lookupTrail\": [\n {\n \"reassignedToId\": \"\",\n \"reassignedFromId\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n },\n {\n \"reassignedToId\": \"\",\n \"reassignedFromId\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11407cd1-5064-4619-acec-36738e2dfb41", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId", + "evaluate", + ":configType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments", + "type": "text/plain" + }, + "key": "exclusionFilters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "537e921d-5755-4a63-bbb4-7b7e73159691", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId", + "evaluate", + ":configType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments", + "type": "text/plain" + }, + "key": "exclusionFilters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a1149b7-3819-41a5-ae30-15b8a33dc91f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId", + "evaluate", + ":configType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments", + "type": "text/plain" + }, + "key": "exclusionFilters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "662cdcc7-dac9-4b24-80cb-2f102c2420da", + "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": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId", + "evaluate", + ":configType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments", + "type": "text/plain" + }, + "key": "exclusionFilters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d7162b7-e23a-46f2-8881-6174ecbe8d43", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + ":identityId", + "evaluate", + ":configType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments", + "type": "text/plain" + }, + "key": "exclusionFilters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "tenant-config", + "description": "", + "item": [ + { + "id": "849b7fbf-1407-4559-a635-f3570b728f27", + "name": "Get Tenant-wide Reassignment Configuration settings", + "request": { + "name": "Get Tenant-wide Reassignment Configuration settings", + "description": { + "content": "Gets the global Reassignment Configuration settings for the requestor's tenant.", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9c3a5bc6-a8d3-44c6-9b81-85af1917f504", + "name": "Tenant-wide Reassignment Configuration settings", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa024f98-0cc8-45b5-9c52-2214be6cdf97", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf8baff1-ec86-462e-b6ab-12c86734e3e2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed3380d8-08f4-4cd8-82e2-3aa631943e18", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c86b26be-f3fa-43a5-a0fb-570adaf709ce", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "09956dbb-6a8e-42b0-9a4d-69b88d5cc3f7", + "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": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b7953d30-fb76-4d30-a123-f83999b74aa6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "06ffe3ec-990d-42ea-b8d2-5d0c47781ffd", + "name": "Update Tenant-wide Reassignment Configuration settings", + "request": { + "name": "Update Tenant-wide Reassignment Configuration settings", + "description": { + "content": "Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings.", + "type": "text/plain" + }, + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "695cbd75-7811-4b92-872b-f804ff0b61b0", + "name": "Tenant-wide Reassignment Configuration settings", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"auditDetails\": {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"modifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "611c78ac-8e27-461a-bd6b-ed9cc58f5394", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b26372f5-61b0-4f94-8c38-0ac48a62985d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "09bf6cde-1d5c-45b3-8f28-6d12721b897f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c029ae33-6278-4bf7-b51b-2dff89f9b8bd", + "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": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bb37e796-8a6e-47c4-8ed7-118707ab76ed", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "reassignment-configurations", + "tenant-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"configDetails\": {\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "recommendations", + "description": "", + "item": [ + { + "name": "request", + "description": "", + "item": [ + { + "id": "3d853cb6-cf8d-449b-be4d-fbe02f99ef4e", + "name": "Returns a Recommendation Based on Object", + "request": { + "name": "Returns a Recommendation Based on Object", + "description": { + "content": "The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.", + "type": "text/plain" + }, + "url": { + "path": [ + "recommendations", + "request" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requests\": [\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n },\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n ],\n \"excludeInterpretations\": \"false\",\n \"includeTranslationMessages\": \"false\",\n \"includeDebugInformation\": \"false\",\n \"prescribeMode\": \"false\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "511cdb8c-bcc3-4d8c-8e60-797f694fa624", + "name": "The recommendations for a customer", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "request" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requests\": [\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n },\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n ],\n \"excludeInterpretations\": \"false\",\n \"includeTranslationMessages\": \"false\",\n \"includeDebugInformation\": \"false\",\n \"prescribeMode\": \"false\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"response\": [\n {\n \"request\": {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\"\n }\n },\n \"recommendation\": \"MAYBE\",\n \"interpretations\": [\n \"\",\n \"\"\n ],\n \"translationMessages\": [\n {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recommenderCalculations\": {\n \"identityId\": \"\",\n \"entitlementId\": \"\",\n \"recommendation\": \"\",\n \"overallWeightedScore\": \"\",\n \"featureWeightedScores\": {\n \"magnaef\": \"\"\n },\n \"threshold\": \"\",\n \"identityAttributes\": {\n \"ea_24\": {\n \"value\": \"\"\n },\n \"pariatur_3e7\": {\n \"value\": \"\"\n }\n },\n \"featureValues\": {\n \"feature\": \"\",\n \"numerator\": \"\",\n \"denominator\": \"\"\n }\n }\n },\n {\n \"request\": {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\"\n }\n },\n \"recommendation\": \"NOT_FOUND\",\n \"interpretations\": [\n \"\",\n \"\"\n ],\n \"translationMessages\": [\n {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"key\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"recommenderCalculations\": {\n \"identityId\": \"\",\n \"entitlementId\": \"\",\n \"recommendation\": \"\",\n \"overallWeightedScore\": \"\",\n \"featureWeightedScores\": {\n \"occaecat_c2c\": \"\",\n \"esse_5\": \"\"\n },\n \"threshold\": \"\",\n \"identityAttributes\": {\n \"Duis_ee\": {\n \"value\": \"\"\n },\n \"irure_a\": {\n \"value\": \"\"\n },\n \"velit1\": {\n \"value\": \"\"\n },\n \"in8b\": {\n \"value\": \"\"\n }\n },\n \"featureValues\": {\n \"feature\": \"\",\n \"numerator\": \"\",\n \"denominator\": \"\"\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4560c681-ef34-42a5-aa2a-be0fae571e27", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "request" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requests\": [\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n },\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n ],\n \"excludeInterpretations\": \"false\",\n \"includeTranslationMessages\": \"false\",\n \"includeDebugInformation\": \"false\",\n \"prescribeMode\": \"false\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d55adc53-f31a-48ab-ab35-17395ef9bcdb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "request" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requests\": [\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n },\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n ],\n \"excludeInterpretations\": \"false\",\n \"includeTranslationMessages\": \"false\",\n \"includeDebugInformation\": \"false\",\n \"prescribeMode\": \"false\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "53e893a9-8b54-4541-ae60-de592c4b673d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "request" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requests\": [\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n },\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n ],\n \"excludeInterpretations\": \"false\",\n \"includeTranslationMessages\": \"false\",\n \"includeDebugInformation\": \"false\",\n \"prescribeMode\": \"false\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "626b0ca1-596d-475e-8a4b-73cd38cfc354", + "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": { + "url": { + "path": [ + "recommendations", + "request" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requests\": [\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n },\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n ],\n \"excludeInterpretations\": \"false\",\n \"includeTranslationMessages\": \"false\",\n \"includeDebugInformation\": \"false\",\n \"prescribeMode\": \"false\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9656f2fa-cd05-4cf8-b3f9-7e99b94992c5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "request" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requests\": [\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n }\n },\n {\n \"identityId\": \"\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"ROLE\"\n }\n }\n ],\n \"excludeInterpretations\": \"false\",\n \"includeTranslationMessages\": \"false\",\n \"includeDebugInformation\": \"false\",\n \"prescribeMode\": \"false\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "config", + "description": "", + "item": [ + { + "id": "4985840a-7d65-4e6a-9c8f-d318b4128335", + "name": "Get certification recommendation config values", + "request": { + "name": "Get certification recommendation config values", + "description": { + "content": "Retrieves configuration attributes used by certification recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "db8e815d-8e33-4554-a79c-f6c818c5eaea", + "name": "Cert recommendation configuration attributes", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"recommenderFeatures\": [\n \"\",\n \"\"\n ],\n \"peerGroupPercentageThreshold\": \"\",\n \"forceRefresh\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "18272b3e-4bce-4f27-8af7-3767a52405be", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8187d6b9-004a-46d5-86a8-5ec188035c39", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d10480d-a671-4cd0-961d-cb7ad116ffd2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fd198305-471f-48b1-aa8c-5b31e6dd53e8", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "dd26c5bc-c91d-4ec1-bbd1-ce7000bb2026", + "name": "Update certification recommendation config values", + "request": { + "name": "Update certification recommendation config values", + "description": { + "content": "Updates configuration attributes used by certification recommendations.", + "type": "text/plain" + }, + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"recommenderFeatures\": [\n \"\",\n \"\"\n ],\n \"peerGroupPercentageThreshold\": \"\",\n \"forceRefresh\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "cd12f92d-2e9c-4cda-8e52-42e06b4ff602", + "name": "Cert recommendation configuration attributes after update", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"recommenderFeatures\": [\n \"\",\n \"\"\n ],\n \"peerGroupPercentageThreshold\": \"\",\n \"forceRefresh\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"recommenderFeatures\": [\n \"\",\n \"\"\n ],\n \"peerGroupPercentageThreshold\": \"\",\n \"forceRefresh\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4fe5d489-9cd6-4d04-b0bb-51d0d624698e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"recommenderFeatures\": [\n \"\",\n \"\"\n ],\n \"peerGroupPercentageThreshold\": \"\",\n \"forceRefresh\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "94bed884-3fde-4644-a317-63a6ad74bde4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"recommenderFeatures\": [\n \"\",\n \"\"\n ],\n \"peerGroupPercentageThreshold\": \"\",\n \"forceRefresh\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8562b76f-047a-4831-a363-24c1886b6bd7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"recommenderFeatures\": [\n \"\",\n \"\"\n ],\n \"peerGroupPercentageThreshold\": \"\",\n \"forceRefresh\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef6103e6-4ddb-4058-960f-b806a8a68af4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "recommendations", + "config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"recommenderFeatures\": [\n \"\",\n \"\"\n ],\n \"peerGroupPercentageThreshold\": \"\",\n \"forceRefresh\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "requestable-objects", + "description": "", + "item": [ + { + "id": "ac6fbc45-3303-4822-8175-42ceb7f1d8b4", + "name": "Requestable Objects List", + "request": { + "name": "Requestable Objects List", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ROLE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "PENDING,AVAILABLE" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3f222303-79a7-4164-a776-e0ddccbd9b02", + "name": "List of requestable objects", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ROLE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "PENDING,AVAILABLE" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\",\n \"requestStatus\": \"PENDING\",\n \"identityRequestId\": \"\",\n \"ownerRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"requestCommentsRequired\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\",\n \"requestStatus\": \"AVAILABLE\",\n \"identityRequestId\": \"\",\n \"ownerRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"requestCommentsRequired\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd06b958-befe-4c14-8428-382d43bfdb89", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ROLE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "PENDING,AVAILABLE" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "94ad9660-ddd7-4655-aa5b-4c4692dc1f71", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ROLE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "PENDING,AVAILABLE" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "301f800f-d2e7-47d2-913a-2bdd0097355c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ROLE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "PENDING,AVAILABLE" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "deb49463-1502-4e9a-ad5c-20f4b6e2e591", + "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": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ROLE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "PENDING,AVAILABLE" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "067822ae-1df7-4294-80b7-31812c360e14", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ROLE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "PENDING,AVAILABLE" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "role-insights", + "description": "", + "item": [ + { + "name": "requests", + "description": "", + "item": [ + { + "id": "abce4a0f-5c2c-4110-9654-c1040544f9f8", + "name": "A request to generate insights for roles", + "request": { + "name": "A request to generate insights for roles", + "description": { + "content": "This submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights", + "requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "7a017288-fef0-496d-9347-d0330840dada", + "name": "Submitted a role insights generation request", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"createdDate\": \"\",\n \"lastGenerated\": \"\",\n \"numberOfUpdates\": \"\",\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"status\": \"COMPLETED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6e0fd7a-5196-42c4-a442-674e47dd5f82", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "463fa6e9-1c82-4ae8-a316-c9c5a6c68c10", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c87a529d-bcbd-4b99-9c5d-f496e0e263a1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbaf3980-1ea4-4ebb-aad5-e53e2b43b38e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "b729a6fd-d9c4-4c0f-9a76-01e43df72ed6", + "name": "Returns the metadata for a request in order to generate insights for roles.", + "request": { + "name": "Returns the metadata for a request in order to generate insights for roles.", + "description": { + "content": "This endpoint returns details of a prior request.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights", + "requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "83621fac-87cd-47ea-a544-b6d847f5c565", + "name": "Succeeded. Returns details of an earlier role insights request.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"createdDate\": \"\",\n \"lastGenerated\": \"\",\n \"numberOfUpdates\": \"\",\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"status\": \"COMPLETED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7c36c9d1-00c9-4a60-870d-67bcf6ea89e2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf67513b-afa8-4d3c-8289-2fa8bcc0bafe", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67f7e666-2c65-4d71-9193-c927da416845", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98140097-b9d6-45df-8e94-150299d03de0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "summary", + "description": "", + "item": [ + { + "id": "8a5dc145-bccd-4c31-9302-70dfc3ad20e9", + "name": "Get role insights summary information", + "request": { + "name": "Get role insights summary information", + "description": { + "content": "This method returns high level summary information for role insights for a customer.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c6333964-3384-4dd5-8f45-824513a40444", + "name": "Succeeded. Returns high level counts.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"numberOfUpdates\": \"\",\n \"lastGenerated\": \"\",\n \"entitlementsIncludedInRoles\": \"\",\n \"totalNumberOfEntitlements\": \"\",\n \"identitiesWithAccessViaRoles\": \"\",\n \"totalNumberOfIdentities\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4544952a-a01d-4036-98e1-d8b8920ca733", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12b0f84b-fb75-4333-a447-708e0599cadd", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "061b2246-5b42-444c-a12f-5d16716c5e53", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b3083651-745f-4282-85a7-45120475cdb0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "id": "78d3f837-348a-45a9-88cc-87fd67f45bf6", + "name": "Get role insights", + "request": { + "name": "Get role insights", + "description": { + "content": "This method returns detailed role insights for each role.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name, ownerName and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "76a4481e-1b42-4998-984b-2a1bc74c3b7c", + "name": "Succeeded. Returns a list of roles with information about insights for each role.", + "originalRequest": { + "url": { + "path": [ + "role-insights" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name, ownerName and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"numberOfUpdates\": \"\",\n \"createdDate\": \"\",\n \"role\": {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"insight\": {\n \"type\": \"\",\n \"identitiesWithAccess\": \"\",\n \"identitiesImpacted\": \"\",\n \"totalNumberOfIdentities\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"numberOfUpdates\": \"\",\n \"createdDate\": \"\",\n \"role\": {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"insight\": {\n \"type\": \"\",\n \"identitiesWithAccess\": \"\",\n \"identitiesImpacted\": \"\",\n \"totalNumberOfIdentities\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5db30e8-37b6-4423-9183-fa23dbd25110", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name, ownerName and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "516b2db1-00e9-40e2-9037-cb8ed2d0900e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name, ownerName and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74f4da6e-93e0-43a3-b416-1d0941ef1981", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name, ownerName and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "139d386b-2c96-40f6-bdd9-c0cf33f17636", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name, ownerName and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{insightId}", + "description": "", + "item": [ + { + "id": "f91a5062-0e04-4e8d-ace9-acf9fe4fa1c6", + "name": "Get a single role insight", + "request": { + "name": "Get a single role insight", + "description": { + "content": "This endpoint gets role insights information for a role.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights", + ":insightId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "insightId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "81c14be6-88d2-4659-a822-e53de77c2b7d", + "name": "Succeeded. Returns information about insights for a single role.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"numberOfUpdates\": \"\",\n \"createdDate\": \"\",\n \"role\": {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"ownerName\": \"\",\n \"ownerId\": \"\"\n },\n \"insight\": {\n \"type\": \"\",\n \"identitiesWithAccess\": \"\",\n \"identitiesImpacted\": \"\",\n \"totalNumberOfIdentities\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8aed577e-92dc-4745-82f1-9f140a8ce651", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "407613b4-5639-4bdd-b852-a118140245bd", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "83958981-38d7-4836-9c15-c0329d66e7ef", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1f860401-fece-491d-99ce-6dca8d6b93cf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "entitlement-changes", + "description": "", + "item": [ + { + "id": "587dd0c3-c283-45ed-9f8d-ecc69222af20", + "name": "Get entitlement insights for a role", + "request": { + "name": "Get entitlement insights for a role", + "description": { + "content": "This endpoint returns entitlement insights for a role.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess or name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "insightId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "a591b48f-07a5-4b73-bf93-95af76c29ffd", + "name": "Succeeded. Returns a list of entitlements to be added for a role.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess or name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"source\": \"\",\n \"insight\": {\n \"type\": \"\",\n \"identitiesWithAccess\": \"\",\n \"identitiesImpacted\": \"\",\n \"totalNumberOfIdentities\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"source\": \"\",\n \"insight\": {\n \"type\": \"\",\n \"identitiesWithAccess\": \"\",\n \"identitiesImpacted\": \"\",\n \"totalNumberOfIdentities\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "83925781-528d-4350-a266-8c120593f4e4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess or name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a65511e-58e1-4beb-a26e-9264a23110b9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess or name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7da823f7-d2ab-4e73-9023-fbc080b4457d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess or name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "372d4f38-7ebe-4d13-81c2-c4230ee24d5e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess or name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "download", + "description": "", + "item": [ + { + "id": "73c72e3f-28c8-4a84-8c63-bf9b9606f07b", + "name": "Download entitlement insights for a role", + "request": { + "name": "Download entitlement insights for a role", + "description": { + "content": "This endpoint returns the entitlement insights for a role.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "insightId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "485e7992-4fcb-43fb-8f3a-3d13604cdb59", + "name": "Succeeded. Returns a csv file containing a list of entitlements to be added for a role.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "7e6e9d02-da63-4bf8-be43-8c47ffe56961", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ae54596-f4c3-4707-976c-359dad578309", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4f591c6-91c3-4399-af72-747c0fe516a4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1af1a652-bf7f-407c-9be5-56465d6e53f1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by identitiesWithAccess, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{entitlementId}", + "description": "", + "item": [ + { + "name": "identities", + "description": "", + "item": [ + { + "id": "d9ac0895-2c34-46db-a62d-df21f4485bd5", + "name": "Get identities for a suggested entitlement (for a role)", + "request": { + "name": "Get identities for a suggested entitlement (for a role)", + "description": { + "content": "Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + ":entitlementId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Identity has this entitlement or not", + "type": "text/plain" + }, + "key": "hasEntitlement", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "insightId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "entitlementId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8ba3adef-31d1-4793-a4dd-dfb7b9af6d95", + "name": "Succeeded. Returns a list of identities with or without the entitlement.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + ":entitlementId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Identity has this entitlement or not", + "type": "text/plain" + }, + "key": "hasEntitlement", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attributes\": {\n \"dolor_9\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attributes\": {\n \"dolor7\": \"\",\n \"eu_b5\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f69c70da-b6b3-48f6-be19-f6aeb70e6bfc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + ":entitlementId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Identity has this entitlement or not", + "type": "text/plain" + }, + "key": "hasEntitlement", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ad4f1924-a00f-482a-8ba2-03b6ddc319f1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + ":entitlementId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Identity has this entitlement or not", + "type": "text/plain" + }, + "key": "hasEntitlement", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bfc874cf-7060-4310-b918-c9510bb54cc1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + ":entitlementId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Identity has this entitlement or not", + "type": "text/plain" + }, + "key": "hasEntitlement", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b64c94d7-74b8-464e-9da9-e87122e44c31", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "entitlement-changes", + ":entitlementId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Identity has this entitlement or not", + "type": "text/plain" + }, + "key": "hasEntitlement", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "sort by name", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "current-entitlements", + "description": "", + "item": [ + { + "id": "5ec3f92d-e2e1-4d32-a05b-597e2edf671d", + "name": "Get current entitlement for a role", + "request": { + "name": "Get current entitlement for a role", + "description": { + "content": "This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-insights", + ":insightId", + "current-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "insightId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9d70de16-676c-4f34-a091-6425d61ccc07", + "name": "Succeeded. Returns a list of current or pre-existing entitlements for a role.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "current-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"source\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"source\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a48700ad-7097-442d-83a7-a59761c29901", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "current-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0131ce1-246a-49be-9661-dd64802ebd20", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "current-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "77f289f9-d99c-4e08-b429-44d2651a717d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "current-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5f51a227-29cf-476c-9062-ca6aacdf5770", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-insights", + ":insightId", + "current-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter parameter(s) by \"starts with\" for the name and description.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "role-mining-sessions", + "description": "", + "item": [ + { + "id": "82f3a104-e09d-45b4-8d2a-38d2f5ced606", + "name": "Create a role mining session", + "request": { + "name": "Create a role mining session", + "description": { + "content": "This submits a create role mining session request to the role mining application.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b45f65fa-48fb-491a-ad76-e5cb2c8eded3", + "name": "Submitted a role mining session request", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"pruneThreshold\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"id\": \"\",\n \"createdDate\": \"\",\n \"modifiedDate\": \"\",\n \"type\": \"COMMON\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4129a09d-9ada-4610-a29d-527cef37e746", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3d7891f-31f7-4fc9-b4a1-09c284d3c7f4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01f00356-1fbd-46be-b5cd-90f38acb65c5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9681669f-42ed-46ba-9ae3-05f9c57f983b", + "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": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ad861c90-aad5-431f-abb8-ce01147fde19", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1a7fe9d8-669a-4914-9268-73ba0677c5cc", + "name": "Retrieves all role mining sessions", + "request": { + "name": "Retrieves all role mining sessions", + "description": { + "content": "Returns all role mining sessions that match the query parameters", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **createdBy, createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "525b33e0-c912-4907-b79c-f288fce7e6b7", + "name": "Succeeded. Returns all role mining sessions that match the query parameters.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **createdBy, createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"COMMON\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n },\n {\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"pruneThreshold\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"type\": \"COMMON\",\n \"emailRecipientId\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"identityCount\": \"\",\n \"saved\": \"\",\n \"name\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "597e4928-fc85-4d83-be35-b6ae58651ec7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **createdBy, createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b3a2530-3e96-4483-a2e6-1455c3fc797a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **createdBy, createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e56f3b0d-8a7c-4be5-b7a4-8f861ab27e73", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **createdBy, createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "189bf9c1-c871-44ba-a53c-6b4fdcb23d9d", + "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": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **createdBy, createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e384957a-73fb-4c25-a126-b4b57e4a30b5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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: **createdBy, createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{sessionId}", + "description": "", + "item": [ + { + "id": "97d7833f-03f0-46a6-bc28-37f66409a5ff", + "name": "Patch a role mining session", + "request": { + "name": "Patch a role mining session", + "description": { + "content": "The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "5f732053-b95c-4498-a33c-30c2b8660504", + "name": "Success", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "061fb682-7152-414a-aa6a-edda45d87cd1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dca17afa-b832-4554-8f3a-2d42a34dec80", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "59b41be5-6705-4a83-b23f-b2c6645315f2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "834663cf-5c89-4dd3-bab4-cb34df3b6855", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a41342b-edbc-4e34-bd43-7dee935df9f2", + "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": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "726684b8-8632-4a25-805a-8dec4bc43d26", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f074270c-93c8-4123-9a0b-b1787a7e2ac4", + "name": "Get a role mining session", + "request": { + "name": "Get a role mining session", + "description": { + "content": "The method retrieves a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "50b23655-0cd3-454a-97a3-3a4d0b58d13e", + "name": "Returns a role mining session", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"prescribedPruneThreshold\": \"\",\n \"pruneThreshold\": \"\",\n \"potentialRoleCount\": \"\",\n \"potentialRolesReadyCount\": \"\",\n \"status\": {\n \"state\": \"\"\n },\n \"id\": \"\",\n \"createdDate\": \"\",\n \"modifiedDate\": \"\",\n \"type\": \"COMMON\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3cc9029b-1c85-493c-8b44-8f8dd5fdd4c1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8be8ab7-fb29-4915-8f51-12370a335777", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5353d331-ba5f-43b0-92bf-8d9a389127aa", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "745ce913-c8f5-453d-b3d0-935a2a0d735e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75155c9e-b255-4396-a0bd-3db180f7e020", + "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": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6d2ad4f-74ad-4d46-b6f8-41cb1adfca46", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "status", + "description": "", + "item": [ + { + "id": "ae66d192-39e5-44df-ba1f-bab465d4ae22", + "name": "Get role mining session status state", + "request": { + "name": "Get role mining session status state", + "description": { + "content": "This method returns a role mining session status for a customer.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "2ff412fa-01be-46de-82bb-13e60ad4ddca", + "name": "Succeeded. Returns session status", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"state\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40a15138-8026-4676-bb82-6cc5337ffecf", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "93beb3b2-8fc9-46a2-9b54-4689361d57de", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3c96ad7d-625a-42f5-9704-7d58021cbf7a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e0e97fe-3e54-433d-8ee0-09c0e275c7ff", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "potential-role-summaries", + "description": "", + "item": [ + { + "id": "be19d92f-47f5-4bfd-826f-02b12c7dabc1", + "name": "Retrieves all potential role summaries", + "request": { + "name": "Retrieves all potential role summaries", + "description": { + "content": "This method returns the potential role summaries for a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1d7415e2-3ed0-46ab-a639-13c08bae5345", + "name": "Succeeded. Returns a list of potential role summaries for a role mining session.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"potentialRoleRef\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"identityCount\": \"\",\n \"entitlementCount\": \"\",\n \"identityGroupStatus\": \"\",\n \"provisionState\": \"FAILED\",\n \"roleId\": \"\",\n \"density\": \"\",\n \"freshness\": \"\",\n \"quality\": \"\"\n },\n {\n \"potentialRoleRef\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"identityCount\": \"\",\n \"entitlementCount\": \"\",\n \"identityGroupStatus\": \"\",\n \"provisionState\": \"FAILED\",\n \"roleId\": \"\",\n \"density\": \"\",\n \"freshness\": \"\",\n \"quality\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c6486cd0-8c90-4ded-ab05-e7815ae059dd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "09cd1412-7b8b-464f-abe7-bd1ede0fcff5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e076a9b5-ae0e-4360-b584-969086f5932c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e4880779-2bde-44c4-8ebe-c90cb33797eb", + "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": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c810b01-43a6-4dd2-81e6-64daba60479e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{potentialRoleId}", + "description": "", + "item": [ + { + "id": "7c4f3633-412c-4f11-8821-aa7fb4fa5228", + "name": "Retrieves a specific potential role", + "request": { + "name": "Retrieves a specific potential role", + "description": { + "content": "This method returns a specific potential role for a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f51bfbcd-9d9b-492b-8611-0725922203e1", + "name": "Succeeded. Returns a list of potential roles for a role mining session.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"density\": \"\",\n \"description\": \"\",\n \"entitlementCount\": \"\",\n \"excludedEntitlements\": [\n \"\",\n \"\"\n ],\n \"freshness\": \"\",\n \"identityCount\": \"\",\n \"identityDistribution\": [\n {\n \"attributeName\": \"\",\n \"distribution\": [\n {\n \"ex_33\": \"\"\n },\n {\n \"in__7\": \"\",\n \"nulla491\": \"\",\n \"et_180\": \"\"\n }\n ]\n },\n {\n \"attributeName\": \"\",\n \"distribution\": [\n {\n \"consecteturb\": \"\"\n },\n {\n \"eu41\": \"\"\n }\n ]\n }\n ],\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"provisionState\": \"FAILED\",\n \"quality\": \"\",\n \"roleId\": \"\",\n \"saved\": \"\",\n \"session\": {\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"name\": \"\",\n \"pruneThreshold\": \"\",\n \"saved\": true,\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"state\": {\n \"state\": \"\"\n },\n \"scopingMethod\": {\n \"state\": \"\"\n }\n },\n \"type\": \"SPECIALIZED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e1685dc-8d4c-440f-8310-7bc31110d377", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d99e92e0-f6d8-48d0-8c46-49e2f2edd18d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f5812d6-18e9-48d0-a7ba-01bc1ba83505", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff45fef3-7dbc-4058-9438-87c5c5e6627c", + "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": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "532faa58-5b9c-494f-a86f-234b81d6d4c2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "db47ccea-12c6-441a-8c11-7cfce45b15dd", + "name": "Update a potential role", + "request": { + "name": "Update a potential role", + "description": { + "content": "The method updates an existing potential role using.\n\nThe following fields can be modified:\n\n* `description`\n\n* `name`\n\n* `saved`\n\n\n>**NOTE: All other fields cannot be modified.**\n", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e1136d2f-abf1-461d-8af5-e7fddb8a201d", + "name": "Succeeded. Returns the potential role summary based on the potentialRoleId provided.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "872dba57-b7aa-49af-afb2-1ba1370bae6b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dce60685-9157-4000-bb54-f88f9f3b2108", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6759a568-dba1-436e-94e0-414c377bcd6f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5ead92b-734e-478d-8b58-d98c1e965a5f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51fcc805-da7a-4825-a58b-468ab068d535", + "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": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e079bc5a-b09e-4287-af44-1385c33080f7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "applications", + "description": "", + "item": [ + { + "id": "00137cc0-7c8e-4f1a-928d-995740f734f7", + "name": "Retrieves the applications of a potential role for a role mining session", + "request": { + "name": "Retrieves the applications of a potential role for a role mining session", + "description": { + "content": "This method returns the applications of a potential role for a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId", + "applications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8d01ec59-17be-44a5-802b-9f543b0a36e7", + "name": "Succeeded. Returns a list of potential roles for a role mining session.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId", + "applications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9ed260d-9cdd-4c14-8ca1-c472e6f4498b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId", + "applications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c2ee9a4-a682-4367-af9d-06714658164d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId", + "applications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67f3f2d2-169d-4724-b184-0c397b4885fb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId", + "applications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb242e3b-bb6e-4ed1-a8ed-a24151d821f1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-role-summaries", + ":potentialRoleId", + "applications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "potential-roles", + "description": "", + "item": [ + { + "name": "{potentialRoleId}", + "description": "", + "item": [ + { + "name": "entitlement-popularities", + "description": "", + "item": [ + { + "id": "8a857356-2458-4236-a25d-0cb2300041a5", + "name": "Retrieves entitlements for a potential role in a role mining session", + "request": { + "name": "Retrieves entitlements for a potential role in a role mining session", + "description": { + "content": "This method returns entitlements for a potential role in a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "10568f5c-a313-466a-b9c1-66a8ab6c9d13", + "name": "Succeeded. Returns a list of entitlements for a potential role.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"entitlementRef\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"name\": \"\",\n \"applicationName\": \"\",\n \"identityCount\": \"\",\n \"popularity\": \"\",\n \"popularityInOrg\": \"\"\n },\n {\n \"entitlementRef\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"name\": \"\",\n \"applicationName\": \"\",\n \"identityCount\": \"\",\n \"popularity\": \"\",\n \"popularityInOrg\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "41c9a054-8dc9-4a74-a983-ef36d5918c2e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30ea7898-75dd-494d-b925-f0f60e5c1f63", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "02a91586-a909-44d2-8902-78a140777bd8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "047e9383-48d3-49e3-a531-bfc9b80f34f4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "entitlement-popularity-distribution", + "description": "", + "item": [ + { + "id": "e5bf5509-340b-471d-ad20-712394ba438a", + "name": "Retrieves entitlement popularity distribution for a potential role in a role mining session", + "request": { + "name": "Retrieves entitlement popularity distribution for a potential role in a role mining session", + "description": { + "content": "This method returns entitlement popularity distribution for a potential role in a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularity-distribution" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "642a16d4-6ce4-4943-a956-730c96056ed0", + "name": "Succeeded. Returns a map containing entitlement popularity distribution for a potential role.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularity-distribution" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"exercitation_2\": \"\",\n \"eu_fbe\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa17dd8f-56b5-4508-9cb9-6a0a48ba3445", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularity-distribution" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e131b54-afff-4340-8924-3388df451cd0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularity-distribution" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2fa341df-c59a-4921-88cb-8a7936b653a4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularity-distribution" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab5bf9af-ea70-4455-890c-c74ad0994bd5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "entitlement-popularity-distribution" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included or not", + "type": "text/plain" + }, + "key": "includeCommonAccess", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "edit-entitlements", + "description": "", + "item": [ + { + "id": "8a3460af-8ca4-4c86-b79c-a2f3644c9c58", + "name": "Edit entitlements for a potential role to exclude some entitlements", + "request": { + "name": "Edit entitlements for a potential role to exclude some entitlements", + "description": { + "content": "This endpoint adds or removes entitlements from an exclusion list for a potential role.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "edit-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"exclude\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "fa67929d-ebe6-4d02-94e6-820027d14015", + "name": "Adds or removes entitlements from a potential role's entitlement exclusion list.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "edit-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"exclude\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"createdBy\": {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n \"density\": \"\",\n \"description\": \"\",\n \"entitlementCount\": \"\",\n \"excludedEntitlements\": [\n \"\",\n \"\"\n ],\n \"freshness\": \"\",\n \"identityCount\": \"\",\n \"identityDistribution\": [\n {\n \"attributeName\": \"\",\n \"distribution\": [\n {\n \"ex_33\": \"\"\n },\n {\n \"in__7\": \"\",\n \"nulla491\": \"\",\n \"et_180\": \"\"\n }\n ]\n },\n {\n \"attributeName\": \"\",\n \"distribution\": [\n {\n \"consecteturb\": \"\"\n },\n {\n \"eu41\": \"\"\n }\n ]\n }\n ],\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"provisionState\": \"FAILED\",\n \"quality\": \"\",\n \"roleId\": \"\",\n \"saved\": \"\",\n \"session\": {\n \"minNumIdentitiesInPotentialRole\": \"\",\n \"name\": \"\",\n \"pruneThreshold\": \"\",\n \"saved\": true,\n \"scope\": {\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"criteria\": \"\"\n },\n \"type\": \"SPECIALIZED\",\n \"state\": {\n \"state\": \"\"\n },\n \"scopingMethod\": {\n \"state\": \"\"\n }\n },\n \"type\": \"SPECIALIZED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "402942f0-5e1c-484d-a7f5-2a7d0638e5e0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "edit-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"exclude\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ea154eb-9403-44a7-8836-3e9ab8f2a4ea", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "edit-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"exclude\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "69cb199a-e3f1-4d81-a5c8-16da6ab79848", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "edit-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"exclude\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67cf66bf-286c-4cab-ae58-9233334be847", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "edit-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"exclude\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "identities", + "description": "", + "item": [ + { + "id": "aff4baa3-3539-4756-b802-1d8b0fdb16bd", + "name": "Retrieves identities for a potential role in a role mining session", + "request": { + "name": "Retrieves identities for a potential role in a role mining session", + "description": { + "content": "This method returns identities for a potential role in a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by name, default order ascending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "80c9f94a-bd54-41e0-9a80-c5c04ae6c703", + "name": "Succeeded. Returns a list of identities for a potential role.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by name, default order ascending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attributes\": {\n \"labore4\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attributes\": {\n \"commodo_1\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81cb849b-53dc-4e99-92de-5bfddf3dfd94", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by name, default order ascending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9de99e31-3065-447d-9539-1fe859793f52", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by name, default order ascending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62b78365-77ec-4ead-ade0-ea47011437bc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by name, default order ascending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "069cfce2-052b-455e-a57c-4d6791004bcb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by name, default order ascending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "export", + "description": "", + "item": [ + { + "id": "a5e155b1-bb64-499e-91fd-5fce3f2381fb", + "name": "Export (download) details for a potential role in a role mining session", + "request": { + "name": "Export (download) details for a potential role in a role mining session", + "description": { + "content": "This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "24608dca-2ff6-4fd3-9e82-533582253ccf", + "name": "Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "8b847bac-9945-4689-9b90-46a72168820d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fed925b3-87b9-4271-910a-2054a737cefa", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "58c6d4bb-ae4b-4ea0-bda6-fab1e8659173", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "734a71c3-d99a-4b70-a3ef-dd7b57593ec6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "export-async", + "description": "", + "item": [ + { + "id": "863cbb25-70a5-4afe-897a-eaf9d7d1c59e", + "name": "Asynchronously export details for a potential role in a role mining session and upload to S3", + "request": { + "name": "Asynchronously export details for a potential role in a role mining session and upload to S3", + "description": { + "content": "This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"minEntitlementPopularity\": \"\",\n \"includeCommonAccess\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ddf01b7f-f4b5-409d-85f7-6e19eecb897d", + "name": "Job Submitted. Returns a reportId that can be used to download the zip once complete", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"minEntitlementPopularity\": \"\",\n \"includeCommonAccess\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"minEntitlementPopularity\": \"\",\n \"includeCommonAccess\": \"\",\n \"exportId\": \"\",\n \"status\": \"QUEUED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb9471da-cca3-4400-8491-f4c143a9aeb9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"minEntitlementPopularity\": \"\",\n \"includeCommonAccess\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc274df3-3cc2-425b-b2e3-e1f8ec1283e1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"minEntitlementPopularity\": \"\",\n \"includeCommonAccess\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ac6b7878-3ac8-4e12-a193-7dff29111933", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"minEntitlementPopularity\": \"\",\n \"includeCommonAccess\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5a63d0a-c918-4159-bee1-8a7c9b0c5a74", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"minEntitlementPopularity\": \"\",\n \"includeCommonAccess\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{exportId}", + "description": "", + "item": [ + { + "id": "f6661c24-99f5-455f-aae8-258a25a61efe", + "name": "Retrieve status of a potential role export job", + "request": { + "name": "Retrieve status of a potential role export job", + "description": { + "content": "This endpoint retrieves information about the current status of a potential role export.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "exportId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "db7c740b-beab-45e5-8528-796d7a1a1fb6", + "name": "Success. Returns the current status of this export", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"minEntitlementPopularity\": \"\",\n \"includeCommonAccess\": \"\",\n \"exportId\": \"\",\n \"status\": \"QUEUED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bfff1d7d-5f1a-405c-a1ea-0574c4568462", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "220b6079-5d78-44e2-ab81-a05fb8ec1964", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dbd2662c-d5ee-449b-9054-54b216d491d6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "37bac9f2-8047-4191-b084-655a4a33b2ea", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "download", + "description": "", + "item": [ + { + "id": "1da29adc-7737-479c-a8c6-374c42d4ee17", + "name": "Export (download) details for a potential role in a role mining session", + "request": { + "name": "Export (download) details for a potential role in a role mining session", + "description": { + "content": "This endpoint downloads a completed export of information for a potential role in a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "exportId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5b4b4eb5-443d-45da-8c4e-1826ba16e5b0", + "name": "Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "cdc180a9-c03d-4016-b90c-3af1e5b3173e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "788c232a-0324-4f89-b3cc-bee52fc5373d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3241206d-2235-457c-8d4d-13604f3c8a09", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ccbcce5e-b3b7-43e7-b832-144232445dcf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "export-async", + ":exportId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "provision", + "description": "", + "item": [ + { + "id": "f8d8869d-d7f7-4895-87ca-150a971efb87", + "name": "Create request to provision a potential role into an actual role.", + "request": { + "name": "Create request to provision a potential role into an actual role.", + "description": { + "content": "This method starts a job to provision a potential role", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "provision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Minimum popularity required for an entitlement to be included in the provisioned role.", + "type": "text/plain" + }, + "key": "min-entitlement-popularity", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included in the provisioned role.", + "type": "text/plain" + }, + "key": "include-common-access", + "value": "true" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\",\n \"roleDescription\": \"\",\n \"ownerId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "592ba873-051c-459d-855b-796ab3fcfff2", + "name": "Accepted. Returns a potential role summary including the status of the provison request", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "provision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Minimum popularity required for an entitlement to be included in the provisioned role.", + "type": "text/plain" + }, + "key": "min-entitlement-popularity", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included in the provisioned role.", + "type": "text/plain" + }, + "key": "include-common-access", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\",\n \"roleDescription\": \"\",\n \"ownerId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"potentialRoleRef\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"identityCount\": \"\",\n \"entitlementCount\": \"\",\n \"identityGroupStatus\": \"\",\n \"provisionState\": \"FAILED\",\n \"roleId\": \"\",\n \"density\": \"\",\n \"freshness\": \"\",\n \"quality\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1e3c660-c4d6-40c9-9c81-87aa74f4cd2f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "provision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Minimum popularity required for an entitlement to be included in the provisioned role.", + "type": "text/plain" + }, + "key": "min-entitlement-popularity", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included in the provisioned role.", + "type": "text/plain" + }, + "key": "include-common-access", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\",\n \"roleDescription\": \"\",\n \"ownerId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "998abdc1-3fe2-4d8c-8c24-096fec3aab7a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "provision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Minimum popularity required for an entitlement to be included in the provisioned role.", + "type": "text/plain" + }, + "key": "min-entitlement-popularity", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included in the provisioned role.", + "type": "text/plain" + }, + "key": "include-common-access", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\",\n \"roleDescription\": \"\",\n \"ownerId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d178b92b-e1c9-4add-9d29-34bab15eae9e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "provision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Minimum popularity required for an entitlement to be included in the provisioned role.", + "type": "text/plain" + }, + "key": "min-entitlement-popularity", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included in the provisioned role.", + "type": "text/plain" + }, + "key": "include-common-access", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\",\n \"roleDescription\": \"\",\n \"ownerId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efefe145-4587-4e55-b017-e3060f24719b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "provision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Minimum popularity required for an entitlement to be included in the provisioned role.", + "type": "text/plain" + }, + "key": "min-entitlement-popularity", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included in the provisioned role.", + "type": "text/plain" + }, + "key": "include-common-access", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\",\n \"roleDescription\": \"\",\n \"ownerId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1785cb4d-1965-409c-bddf-dc43a2486a24", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "provision" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Minimum popularity required for an entitlement to be included in the provisioned role.", + "type": "text/plain" + }, + "key": "min-entitlement-popularity", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Boolean determining whether common access entitlements will be included in the provisioned role.", + "type": "text/plain" + }, + "key": "include-common-access", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\",\n \"roleDescription\": \"\",\n \"ownerId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "excluded-entitlements", + "description": "", + "item": [ + { + "id": "63313f04-3c77-4702-9750-855c605c83b7", + "name": "Retrieves excluded entitlements for a potential role in a role mining session", + "request": { + "name": "Retrieves excluded entitlements for a potential role in a role mining session", + "description": { + "content": "This method returns excluded entitlements for a potential role in a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "excluded-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "potentialRoleId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "cb4c78be-566c-48d7-be4c-24d2c2ff9355", + "name": "Succeeded. Returns a list of excluded entitlements for a potential roles.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "excluded-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"entitlementRef\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"name\": \"\",\n \"applicationName\": \"\",\n \"identityCount\": \"\",\n \"popularity\": \"\",\n \"popularityInOrg\": \"\"\n },\n {\n \"entitlementRef\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"name\": \"\",\n \"applicationName\": \"\",\n \"identityCount\": \"\",\n \"popularity\": \"\",\n \"popularityInOrg\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4856b886-ee4b-4654-b768-dc4f2fd86b14", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "excluded-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c8567237-5f6b-4e25-ac34-7969e6ba318f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "excluded-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5f40c9d9-aea5-40a3-88b3-4ccd9d0bb071", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "excluded-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b97fc06c-f777-4a2c-80f2-282aaf1328c6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + ":potentialRoleId", + "excluded-entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "sort by popularity, default order descending", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "draft-roles", + "description": "", + "item": [ + { + "id": "c80f3369-ff5a-4a1f-8802-7de958bc01aa", + "name": "Retrieves all draft roles", + "request": { + "name": "Retrieves all draft roles", + "description": { + "content": "This method returns all saved potential roles (draft roles) for a role mining session.", + "type": "text/plain" + }, + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + "draft-roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**description**: *sw, co*\n**name**: *eq, sw, co*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sessionId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "09d71716-7313-4065-bdef-4be73c0f83f8", + "name": "Succeeded. Returns a list of draft roles for a role mining session.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + "draft-roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**description**: *sw, co*\n**name**: *eq, sw, co*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"description\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"excludedEntitlements\": [\n \"\",\n \"\"\n ],\n \"modified\": \"\",\n \"name\": \"\",\n \"type\": \"SPECIALIZED\"\n },\n {\n \"description\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"entitlementIds\": [\n \"\",\n \"\"\n ],\n \"excludedEntitlements\": [\n \"\",\n \"\"\n ],\n \"modified\": \"\",\n \"name\": \"\",\n \"type\": \"SPECIALIZED\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a505a3f-2984-434c-be56-1a7873092d04", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + "draft-roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**description**: *sw, co*\n**name**: *eq, sw, co*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b95276d-3560-40fb-a26d-a3e2bfef4778", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + "draft-roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**description**: *sw, co*\n**name**: *eq, sw, co*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ef2d468-114a-428c-b432-5371921c3522", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + "draft-roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**description**: *sw, co*\n**name**: *eq, sw, co*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "92af54c4-7038-4741-8723-8d5a4a8884cf", + "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": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + "draft-roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**description**: *sw, co*\n**name**: *eq, sw, co*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7aad2e77-0755-4241-b34d-fabe4e0ae092", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "role-mining-sessions", + ":sessionId", + "potential-roles", + "draft-roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**description**: *sw, co*\n**name**: *eq, sw, co*\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "roles", + "description": "", + "item": [ + { + "id": "e442d1be-9466-456e-a5f3-1c338b46f4c1", + "name": "List Roles", + "request": { + "name": "List Roles", + "description": { + "content": "This API returns a list of Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5866fd34-9532-4955-a1da-9a28e894c725", + "name": "List of Roles", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"Ut_d09\": 87461597\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"esse_834\": 76537417.61770502\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bdd4d0ff-9f72-4cf2-b023-6a6d116ef894", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8727d281-aa7b-4c59-94ab-fa86fddef2c7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "69e305f3-deac-41bb-8946-a6d201c5a42b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "82242100-a2a8-408a-b633-be7c979f81de", + "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": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "78f8392e-8d17-4cc7-9676-60c3aba10111", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "902ecdbd-7de1-45af-a441-716409b39817", + "name": "Create a Role", + "request": { + "name": "Create a Role", + "description": { + "content": "This API creates a role.\nYou must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. \nIn addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. \nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "17bfb38f-3bcb-400e-a0fb-689ee32b8b02", + "name": "Role created", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11a6d1c4-19b4-4edc-b775-52def328c7ec", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0bff7fa-da57-49b8-a980-a16432853306", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5fdff73-918c-4aa9-a8a2-782ca01c331b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a68c735c-1a92-4bd7-825e-1d85e284b079", + "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": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "14f04f19-ee6a-4440-b77d-e2071aa108f7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "97f8e56b-95cb-480a-8c2d-fd6d0b035110", + "name": "Get a Role", + "request": { + "name": "Get a Role", + "description": { + "content": "This API returns a Role by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f7f956d4-03b3-4aa7-949f-2b9d25672f88", + "name": "List of all Roles", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62d7a178-3d7c-45ce-95f0-ad8369143af1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49e12977-2bd5-41e0-bac2-76ebf936f830", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6b1273ec-676e-4878-a2cc-1f7721b5754b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b8ac2871-82b4-4874-b4b8-7f3bd1c5018b", + "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": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "23b37f26-44b6-4a68-b168-1dbef33bce30", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ef61b864-892e-45a9-997a-a61a5b6196b2", + "name": "Patch a specified Role", + "request": { + "name": "Patch a specified Role", + "description": { + "content": "This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f9d97296-ba87-4a02-90b0-30103714905a", + "name": "Responds with the Role as updated.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"in_e5c\": \"magna\",\n \"minim_90\": -98882918.88234444,\n \"labore_2\": 52990572.1577757\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3fdc1ea4-dd88-495c-9472-e9083548bd22", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2ab7ad5-acbd-4f56-a3d6-090a41a271d6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ff3edb4-82b1-4235-9851-63664d349a2f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1757b60b-0c71-4287-91c2-f536e0674d58", + "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": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99b41115-321b-4c04-8933-02187e94a891", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f3c6526e-8f91-4057-9cf6-ee0dd985fbdd", + "name": "Delete a Role", + "request": { + "name": "Delete a Role", + "description": { + "content": "This API deletes a Role by its ID.\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "aca97427-a770-42f4-a0b3-d0fee4d5e7a2", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "ca68890b-06d5-40b5-a52f-066b5eba78da", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49a84e7d-efd8-4c45-9c24-65a48a66b541", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bdbf6365-d38a-44a3-8859-b0ecf3379724", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e3f4d26-5661-4cb4-bb4a-92473211ebc2", + "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": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0891d65-a5e1-4665-a791-b7364d0d3d57", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "assigned-identities", + "description": "", + "item": [ + { + "id": "956320af-3a61-4747-81a8-52d07a25d5c4", + "name": "Identities assigned a Role", + "request": { + "name": "Identities assigned a Role", + "description": {}, + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6db0019d-8898-4fe4-bd4b-b7fba876cbdc", + "name": "List of Identities assigned the Role", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"aliasName\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"roleAssignmentSource\": \"ACCESS_REQUEST\"\n },\n {\n \"id\": \"\",\n \"aliasName\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"roleAssignmentSource\": \"ROLE_MEMBERSHIP\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5a2a14a5-3ab6-42a5-a898-315ea6e568aa", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b574f70-6cf4-4ab1-a977-e4424e855df7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "716b0f93-ebc5-405e-aad7-43b5f6d7149a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7a9e55e5-bdc3-45ba-85d0-22e95297e02d", + "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": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb663c4f-e2e5-4ff0-b13f-eaadb1bf6266", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "58d83d26-669c-4922-91dc-69b34b8404b5", + "name": "Delete Role(s)", + "request": { + "name": "Delete Role(s)", + "description": { + "content": "This API initiates a bulk deletion of one or more Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Roles included in the request are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "01a7c044-222c-48ff-b04b-f1388ba5cd25", + "name": "Returns an object with the id of the task performing the delete operation.", + "originalRequest": { + "url": { + "path": [ + "roles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "718f046c-b3c6-497d-a008-380fee9bf3db", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3c0e0764-9fc1-47c2-8697-a46be8c2e8f4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f5b3391-f995-4188-8b9b-55881f087c01", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "37de15cc-05dd-4968-92fb-d1d958ba8225", + "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": { + "url": { + "path": [ + "roles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c18f168c-f7db-4798-b83c-0a55c9b8c861", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roleIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "segments", + "description": "", + "item": [ + { + "id": "035be5f7-d334-470a-ba9a-9a2b8b6d5323", + "name": "Create Segment", + "request": { + "name": "Create Segment", + "description": { + "content": "This API creates a segment. \n>**Note:** Segment definitions may take time to propagate to all identities.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4288ffaf-c1f9-4676-b362-3867665f1a4b", + "name": "Segment created", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81f4d1b5-b2ab-4273-b4f0-e27e5f99e94b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "06d4f2da-5f74-4f04-ae67-e15f31d4ca9a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38abeaf0-2060-491e-b993-33e462ff16ea", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5486f60-7adf-4f73-a6b7-c17a80eccaee", + "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": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8610dc19-6247-4fb8-b173-e7cc9c3fc035", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "32333f06-09cb-4703-b5c7-fbc266f29888", + "name": "List Segments", + "request": { + "name": "List Segments", + "description": { + "content": "This API returns a list of all segments.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "55a1d861-f86d-4ec3-93a1-889a37d10001", + "name": "List of all segments", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5f355b63-a7d5-4eb6-84e5-bcf7a0e079fe", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea269718-39de-45e5-91e9-cba93669ac84", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "324e06dc-2829-45c6-9fd7-1e2309c551cc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a04ec6f-8d44-4b73-8215-78cc4c8f18dd", + "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": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4c54d378-13a4-4061-a1d8-8ec4ef44f910", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "af7a2183-a518-4860-8a5e-33e4fa00b424", + "name": "Get Segment by ID", + "request": { + "name": "Get Segment by ID", + "description": { + "content": "This API returns the segment specified by the given ID.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "71268a46-dad8-492a-b4fa-2aee7f500e14", + "name": "Segment", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1dcfba6c-00cf-452b-96fb-3747a6da15f7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "791a7567-9909-4f18-b8cc-ea3b07556b3b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "05e2974a-2ea7-4efb-9baa-187dced5dea4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e6055bbf-3dfc-4beb-aa50-7a50f9f378f7", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12882e7f-44fe-45cc-b797-1036186320f3", + "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": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb2b8712-dbc9-4636-a7e1-df519e028b4b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1da0d60e-54b0-48b8-a97f-3fac5c880b12", + "name": "Delete Segment by ID", + "request": { + "name": "Delete Segment by ID", + "description": { + "content": "This API deletes the segment specified by the given ID.\n>**Note:** Segment deletion may take some time to go into effect. \nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "daca75d8-0ba6-4534-bf83-c62a13da18c8", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "09488828-2877-4474-b38e-c2d3db27dc3a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eceb62e5-188f-41d9-9918-1501f15d8d67", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "70ebd085-94a0-418a-83ff-6a2b27d67acc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf6611eb-46a0-463c-93a4-772fe505eb41", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "15771b48-d592-4bd5-beb0-a0db67d83143", + "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": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8204b13d-5b44-4944-9b6d-88c7f3545319", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "676e0245-e181-4e0b-aad3-9147aa75e520", + "name": "Update Segment", + "request": { + "name": "Update Segment", + "description": { + "content": "Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n>**Note:** Changes to a segment may take some time to propagate to all identities.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c17ac640-d14d-4a9a-a2bb-8aa101cf755b", + "name": "Indicates the PATCH operation succeeded, and returns the segment's new representation.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8045995f-ee04-4fce-a1ba-32906aafd5f9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0dc2aab-c710-4648-b22c-410fc1cc7c5f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "babbd883-00a1-4c33-bbf2-76a9a74a78f5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01d068dd-cea2-45e5-9905-34cf4603e613", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed9280ec-8757-46d3-a6d8-9cc887623b80", + "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": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc346c0e-d26f-463b-a1b5-91942050e1d7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "send-test-notification", + "description": "", + "item": [ + { + "id": "40302902-c1e7-42c8-a5b9-394d8c508d6c", + "name": "Send Test Notification", + "request": { + "name": "Send Test Notification", + "description": { + "content": "Send a Test Notification", + "type": "text/plain" + }, + "url": { + "path": [ + "send-test-notification" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"context\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3dec3c01-0c39-4f80-bc56-5172c67ed0ff", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "send-test-notification" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"context\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "d039fe33-3064-43d6-9fee-16ce525b143f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "send-test-notification" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"context\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "00c1d859-df0c-4909-9630-d3b7204839bf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "send-test-notification" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"context\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a217544b-80f2-4c38-a1a5-78943cd8f588", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "send-test-notification" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"context\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9b5f3f4-fd85-4cb4-8106-0e44ae59125e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "send-test-notification" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"context\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d26f8ed-6efb-42a6-9008-5f97dde9700b", + "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": { + "url": { + "path": [ + "send-test-notification" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"context\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3469d884-dc6f-407b-8d3f-1bc86c845737", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "send-test-notification" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"key\": \"\",\n \"medium\": \"TEAMS\",\n \"context\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "service-desk-integrations", + "description": "", + "item": [ + { + "id": "1232eb77-05ec-4370-9e75-8419ceb18dba", + "name": "List existing Service Desk Integrations", + "request": { + "name": "List existing Service Desk Integrations", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "40b158da-2fac-41a2-8e11-909d0722200a", + "name": "List of ServiceDeskIntegrationDto", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"attributes\": {\n \"in8\": \"esse proident Excepteur\",\n \"minim_b2\": \"do nisi ad non\",\n \"in_9\": -99709670,\n \"amet6a4\": 41553278\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"attributes\": {\n \"aliquip_c5\": true\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "47bdfcbf-5fc5-42c5-abcf-67f4779eb651", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2881591f-cd12-4b51-a2e3-78ab2c87221a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d505661-3529-47ce-ae2f-5330f66d3c03", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c402a87-73b9-4c9d-97ae-a7a28f011152", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "28d97537-cbf6-4f9a-b653-c0a67daaf337", + "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": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a528c1e2-730e-4287-a3eb-22ba87b8b7b4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "82776d1d-f77d-4253-8657-0df809756d8e", + "name": "Create new Service Desk integration", + "request": { + "name": "Create new Service Desk integration", + "description": { + "content": "Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b781578e-e912-470f-b9d8-ececb88c1773", + "name": "details of the created integration", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6900e047-615a-4cf9-bb27-fc3ac1a2873c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ed9ae6d-5d1a-4402-993d-96ebc034af6f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a7e79ecd-1211-41b3-b6f3-b84d6b033438", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef822292-6113-4a79-bd56-e7a347290df2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bb19e41-0751-4bca-855f-f494c954e8ee", + "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": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef20b7d9-71d6-4ce6-af85-e48dc78ad083", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "5f848e91-b7ef-492b-aa1b-38484ab8a534", + "name": "Get a Service Desk integration", + "request": { + "name": "Get a Service Desk integration", + "description": { + "content": "Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "eefbe1f3-a8d9-45c8-be3b-0ccc8d60708a", + "name": "ServiceDeskIntegrationDto with the given ID", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9df50b59-9d5b-4313-b3c2-ea536d8d74d0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f715918-9c06-4bb0-bd14-85b854adfc8a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b321f4cf-8ef3-42a3-b524-7372521b987c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "982a8eb4-72a8-4850-a6d5-ba3b0ca106c8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95f1bc11-8443-453b-8e58-d8ac550aecd4", + "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": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a90b2b83-25bf-4ef3-8599-06d561078c11", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "bbc16fbd-9cc3-4d38-8033-fb05175670c5", + "name": "Update a Service Desk integration", + "request": { + "name": "Update a Service Desk integration", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "127548e0-fb79-4347-9cfd-f8112a85311b", + "name": "ServiceDeskIntegrationDto as updated", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5ee08aa-639a-4eca-869e-d97f258b44eb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c52461c7-7edf-4105-b9de-70f41f602a7a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a2d293d-276a-4294-a864-cf98ea3ab109", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bd4d7efd-383c-4408-bc17-6734b562c1b0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3ccae6f-02b2-40a0-8d52-b90ff39433eb", + "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": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f69597a0-9ea0-42f4-8c4a-12b5f99291ea", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "71d31409-1a0b-432e-a662-1c4667052520", + "name": "Delete a Service Desk integration", + "request": { + "name": "Delete a Service Desk integration", + "description": { + "content": "Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "65fafeb7-5907-49d5-a769-59de9ca1b830", + "name": "Service Desk integration with the given ID successfully deleted", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "5721d58f-a834-4551-925f-4e068898b29d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "488b028f-2817-4b64-a421-7d6b50b43616", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3182a612-5b13-4bb5-8332-55c71cfe1a82", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "257285e2-8d54-49e6-b044-b18f804b1d99", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1b821342-1c8a-4fed-8f50-a14c81dface4", + "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": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "551b1106-789f-4954-8efd-fdb0054760f7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "fbec53b8-81c1-4176-afd8-9de34aee82e7", + "name": "Service Desk Integration Update PATCH", + "request": { + "name": "Service Desk Integration Update PATCH", + "description": { + "content": "Update an existing ServiceDeskIntegration by ID with a PATCH request.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ccf2072a-7fad-4339-8995-d046d88cc607", + "name": "ServiceDeskIntegrationDto as updated", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"voluptate_7d\": -538292\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3f2ecee8-0c07-4f98-b31a-00ffa29b53c0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4367f82-e42e-4cf3-ab58-ccfb0b575c4c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5270b85-1014-4959-9552-57ef249ffec1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0c8fa12-0b9a-4896-aa67-0103834b3055", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fe168322-04b5-4d06-9e4a-46766d7af508", + "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": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97b964c1-4077-4f3b-ac22-b0e09c8e1e3e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "types", + "description": "", + "item": [ + { + "id": "7f787faa-78c5-4635-b44f-995c0928f47a", + "name": "Service Desk Integration Types List.", + "request": { + "name": "Service Desk Integration Types List.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "a769d403-a477-4630-9cca-67ec646e8ad9", + "name": "Responds with an array of the currently supported Service Desk integration types.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"type\": \"\",\n \"scriptName\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"\",\n \"scriptName\": \"\",\n \"name\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1c33915d-282e-407b-bb98-333ec91c7bae", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e6c4e62a-1206-421d-abd9-dcfe684d5370", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cee94e20-07b4-4570-9c60-88d8e9a47b28", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62568b1e-a80f-4e44-a920-47dca1d07ea6", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4cce2406-669f-44ca-b076-bd992fe9b148", + "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": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e84f0920-37cd-4bbe-b583-ac1b0b55a03c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "templates", + "description": "", + "item": [ + { + "name": "{scriptName}", + "description": "", + "item": [ + { + "id": "a9d94f03-d6ac-4521-94b1-fba1350f2e90", + "name": "Service Desk integration template by scriptName.", + "request": { + "name": "Service Desk integration template by scriptName.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "scriptName", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ed6e9a6f-e05c-4235-946e-e7e62e9ffbfe", + "name": "Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"adipisicing0b6\": 81263175.06780261,\n \"reprehenderit8\": -3602634.566450998\n },\n \"name\": \"\",\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"type\": \"Web Service SDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ac1ce9aa-78a3-44a8-9558-bac32b1c11b6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ffe8d6ed-1410-4d1f-a94f-1903efa9cc1a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51c931c8-e33d-434f-9770-83a94907a22e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "23397bb7-29f2-4616-b600-9cc27f768a78", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34221132-1e8f-43a5-b41f-e3b4aabd0329", + "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": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7aa19d45-c6d8-4bf2-a3cc-61fe2a51e990", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "status-check-configuration", + "description": "", + "item": [ + { + "id": "55d40a5c-1289-401a-828a-d992aad73245", + "name": "Get the time check configuration", + "request": { + "name": "Get the time check configuration", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e6956c42-c814-41e3-bacc-0be55ba913e2", + "name": "QueuedCheckConfigDetails containing the configured values", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "028c4c43-8200-4247-82ab-d09d8b65c5d6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "66e95bce-77fe-4d94-911a-509c8ed2100c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ceee3b6c-645a-4fce-b3c4-fc959a6114ae", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75736565-80b6-4814-aeff-f0e1729fac27", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b20c161f-b7d5-4e90-b93e-ac6e89f81f88", + "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": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a85c12e-247b-42fa-827d-4446703c6085", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "01f2e681-1ee0-4f99-b750-7a014870c524", + "name": "Update the time check configuration", + "request": { + "name": "Update the time check configuration", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ef7aab42-e0de-4e00-9a66-4cb4be7beb4d", + "name": "QueuedCheckConfigDetails as updated", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89b2b7da-e5cc-4b53-86b9-223681abbc6f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5fcab85d-6826-4736-bff3-b4c9cf1b8395", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1fd22bb9-e756-493b-87a8-a345a085fe60", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "353679f7-b313-44d3-8632-4f549132c067", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e02b90a-0aa8-41c6-8860-8888d53b866c", + "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": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9066181c-21f8-4cf7-b5bb-7c11dc1f6dd2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "sp-config", + "description": "", + "item": [ + { + "name": "export", + "description": "", + "item": [ + { + "id": "e24a5ac5-7168-4146-ba6f-522cbe7011e9", + "name": "Initiates configuration objects export job", + "request": { + "name": "Initiates configuration objects export job", + "description": { + "content": "This post will export objects from the tenant to a JSON configuration file.\nFor more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).", + "type": "text/plain" + }, + "url": { + "path": [ + "sp-config", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"laborum esse fugiat est\",\n \"excludeTypes\": [\n \"ACCESS_PROFILE\",\n \"TRANSFORM\"\n ],\n \"includeTypes\": [\n \"GOVERNANCE_GROUP\",\n \"ATTR_SYNC_SOURCE_CONFIG\"\n ],\n \"objectOptions\": {\n \"qui_1\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "75edb84a-1ef3-4e43-8a21-6ea32c866f79", + "name": "Export job accepted and queued for processing.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"laborum esse fugiat est\",\n \"excludeTypes\": [\n \"ACCESS_PROFILE\",\n \"TRANSFORM\"\n ],\n \"includeTypes\": [\n \"GOVERNANCE_GROUP\",\n \"ATTR_SYNC_SOURCE_CONFIG\"\n ],\n \"objectOptions\": {\n \"qui_1\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"jobId\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"type\": \"EXPORT\",\n \"message\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8dc1d5e5-3c9d-4b8d-96dc-a539b3c89545", + "name": "Client Error - Returned if the request body is invalid.\n", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"laborum esse fugiat est\",\n \"excludeTypes\": [\n \"ACCESS_PROFILE\",\n \"TRANSFORM\"\n ],\n \"includeTypes\": [\n \"GOVERNANCE_GROUP\",\n \"ATTR_SYNC_SOURCE_CONFIG\"\n ],\n \"objectOptions\": {\n \"qui_1\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5c067530-40e4-4820-a2b8-e04fed69cca6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"laborum esse fugiat est\",\n \"excludeTypes\": [\n \"ACCESS_PROFILE\",\n \"TRANSFORM\"\n ],\n \"includeTypes\": [\n \"GOVERNANCE_GROUP\",\n \"ATTR_SYNC_SOURCE_CONFIG\"\n ],\n \"objectOptions\": {\n \"qui_1\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e9cffc4-e74f-44f0-b58b-5d906dccf1df", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"laborum esse fugiat est\",\n \"excludeTypes\": [\n \"ACCESS_PROFILE\",\n \"TRANSFORM\"\n ],\n \"includeTypes\": [\n \"GOVERNANCE_GROUP\",\n \"ATTR_SYNC_SOURCE_CONFIG\"\n ],\n \"objectOptions\": {\n \"qui_1\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "822dcaf0-d426-45fe-bc44-d7b1147a6731", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"laborum esse fugiat est\",\n \"excludeTypes\": [\n \"ACCESS_PROFILE\",\n \"TRANSFORM\"\n ],\n \"includeTypes\": [\n \"GOVERNANCE_GROUP\",\n \"ATTR_SYNC_SOURCE_CONFIG\"\n ],\n \"objectOptions\": {\n \"qui_1\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "566ec927-ccc6-4a04-88ad-9e4cd05e24bf", + "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": { + "url": { + "path": [ + "sp-config", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"laborum esse fugiat est\",\n \"excludeTypes\": [\n \"ACCESS_PROFILE\",\n \"TRANSFORM\"\n ],\n \"includeTypes\": [\n \"GOVERNANCE_GROUP\",\n \"ATTR_SYNC_SOURCE_CONFIG\"\n ],\n \"objectOptions\": {\n \"qui_1\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9d4ffa1d-6ec3-41df-bdf1-348b860673e9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"laborum esse fugiat est\",\n \"excludeTypes\": [\n \"ACCESS_PROFILE\",\n \"TRANSFORM\"\n ],\n \"includeTypes\": [\n \"GOVERNANCE_GROUP\",\n \"ATTR_SYNC_SOURCE_CONFIG\"\n ],\n \"objectOptions\": {\n \"qui_1\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "bfa3bf8c-4eb2-43b8-aa7f-47251a2be301", + "name": "Get export job status", + "request": { + "name": "Get export job status", + "description": { + "content": "This gets the status of the export job identified by the `id` parameter.\nThe request will need one of the following security scopes:\n- sp:config:read - sp:config:manage", + "type": "text/plain" + }, + "url": { + "path": [ + "sp-config", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5f5dbf16-6ba1-40b3-845f-cbae3cf58154", + "name": "Export job status successfully returned.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"jobId\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"type\": \"EXPORT\",\n \"message\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cde5a027-8acb-4491-94d9-9d6ce6d35edc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5a7489ef-c158-457c-bc16-71bb3db15833", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4c8f0b00-7519-4242-80e5-8a97a1b7dc42", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd329133-5169-4c24-a947-40aee1dbe2e4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2fb62300-81b4-4cd9-bc9e-350ae900daae", + "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": { + "url": { + "path": [ + "sp-config", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4ad46f4f-df7c-4962-a8b3-095f7c79e06c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "download", + "description": "", + "item": [ + { + "id": "ae9734b7-736e-4fb3-9df5-f35b40dc6e53", + "name": "Download export job result.", + "request": { + "name": "Download export job result.", + "description": { + "content": "This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.\nThe request will need one of the following security scopes:\n- sp:config:read - sp:config:manage", + "type": "text/plain" + }, + "url": { + "path": [ + "sp-config", + "export", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "bf7789f9-902e-4a62-912f-1088c4fca987", + "name": "Exported JSON objects.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"version\": \"\",\n \"timestamp\": \"\",\n \"tenant\": \"\",\n \"description\": \"\",\n \"options\": {\n \"excludeTypes\": [\n \"IDENTITY_OBJECT_CONFIG\",\n \"WORKFLOWS\"\n ],\n \"includeTypes\": [\n \"IDENTITY_PROFILE\",\n \"AUTH_ORG\"\n ],\n \"objectOptions\": {\n \"nonb\": {\n \"includedIds\": [\n \"\",\n \"\"\n ],\n \"includedNames\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n \"objects\": [\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"consectetur_54\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"amet_408\": \"eiusmod cillum ex Lorem\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3abcd6b3-aa8a-46c2-b4c8-93efdfca3bd7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "27ce3367-f4c5-4deb-a78b-6af17cc31f5f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "184c4baa-db21-4cbe-8a7b-9a5ddfbb5e08", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3726564c-f1d8-4be3-8d50-6ea18d311455", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd1c04ba-a58e-41f8-9286-652dbe28d03f", + "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": { + "url": { + "path": [ + "sp-config", + "export", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fd3c85fc-f20f-4f10-ae11-fc634b6be84f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "export", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "import", + "description": "", + "item": [ + { + "id": "dc7d7ddf-df24-419e-8a97-60f242eeb3d8", + "name": "Initiates configuration objects import job", + "request": { + "name": "Initiates configuration objects import job", + "description": { + "content": "This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the /sp-config/export/{exportJobId}/download endpoint.\nYou cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. \nFor more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).\nThe request will need the following security scope:\n- sp:config:manage", + "type": "text/plain" + }, + "url": { + "path": [ + "sp-config", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.", + "type": "text/plain" + }, + "key": "preview", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) JSON file containing the objects to be imported.", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "options", + "value": "[object Object]", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "8c4e39a5-8145-4f28-9179-39514466fbc1", + "name": "Import job accepted and queued for processing.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.", + "type": "text/plain" + }, + "key": "preview", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) JSON file containing the objects to be imported.", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "options", + "value": "[object Object]", + "type": "text" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"jobId\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"type\": \"EXPORT\",\n \"message\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f04e95fd-0595-41e5-b46a-bcddcffcc18f", + "name": "Client Error - Returned if the request body is invalid.\n", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.", + "type": "text/plain" + }, + "key": "preview", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) JSON file containing the objects to be imported.", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "options", + "value": "[object Object]", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0cff4e87-4097-4f7f-9905-ae5bad73b64f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.", + "type": "text/plain" + }, + "key": "preview", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) JSON file containing the objects to be imported.", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "options", + "value": "[object Object]", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea9945c0-f7f4-44c1-9543-131acb42eb09", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.", + "type": "text/plain" + }, + "key": "preview", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) JSON file containing the objects to be imported.", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "options", + "value": "[object Object]", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1edfaa5e-6697-445a-a977-1c30b499e6c2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.", + "type": "text/plain" + }, + "key": "preview", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) JSON file containing the objects to be imported.", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "options", + "value": "[object Object]", + "type": "text" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f500b402-05bf-4ccf-a9cd-e02f649c86e9", + "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": { + "url": { + "path": [ + "sp-config", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.", + "type": "text/plain" + }, + "key": "preview", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) JSON file containing the objects to be imported.", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "options", + "value": "[object Object]", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa70902a-788e-4a28-87d1-8871600180da", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.", + "type": "text/plain" + }, + "key": "preview", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) JSON file containing the objects to be imported.", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "options", + "value": "[object Object]", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "02757ffd-bfde-4e2c-93fa-4ee12d97791c", + "name": "Get import job status", + "request": { + "name": "Get import job status", + "description": { + "content": "This gets the status of the import job identified by the `id` parameter.\nFor more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).\nThe request will need the following security scope:\n- sp:config:manage", + "type": "text/plain" + }, + "url": { + "path": [ + "sp-config", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3f7641a2-2d35-4b6b-9c91-892057d21072", + "name": "Import job status successfully returned.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"jobId\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"type\": \"EXPORT\",\n \"message\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aacb60a6-1286-4d1e-b502-1386e051fe53", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e4e712b8-8ae1-4f7d-bb78-09a167a04595", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5bf6e97-fc44-466b-83d9-ec8a953edc37", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b992b75d-c4ba-4c14-9228-828d771e355c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ded81041-a626-4b12-a65b-08e72084d00f", + "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": { + "url": { + "path": [ + "sp-config", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7cb2f2d0-06e4-448a-8992-880931e22bfa", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "download", + "description": "", + "item": [ + { + "id": "4ff643de-7ec8-48a9-aa2b-c03015be6527", + "name": "Download import job result", + "request": { + "name": "Download import job result", + "description": { + "content": "This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import.\nThe request will need the following security scope:\n- sp:config:manage", + "type": "text/plain" + }, + "url": { + "path": [ + "sp-config", + "import", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "0d135a83-82de-4831-854c-2b5c6485538b", + "name": "Import results JSON object, containing detailed results of the import operation.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"results\": {\n \"sunt56\": {\n \"infos\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"aliqua69\": {},\n \"ipsum_f_4\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"est_b4c\": {}\n }\n }\n ],\n \"warnings\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"voluptate_50\": {},\n \"officia_d4\": {},\n \"sed8e\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"ad__\": {},\n \"aliqua__7_\": {},\n \"ea7c\": {},\n \"cillumc\": {}\n }\n }\n ],\n \"errors\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"cillumc\": {},\n \"magnac9d\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"nisi_f\": {}\n }\n }\n ],\n \"importedObjects\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"veniamb\": {\n \"infos\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"nisi777\": {},\n \"dolore4\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"in79\": {}\n }\n }\n ],\n \"warnings\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"minim_190\": {},\n \"adipisicing0f\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"pariatur3\": {},\n \"nulla_f\": {},\n \"pariaturf2\": {}\n }\n }\n ],\n \"errors\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"incididunt0\": {}\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"utbff\": {},\n \"proident_6b\": {}\n }\n }\n ],\n \"importedObjects\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"exportJobId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e62bd271-f39d-4c79-a1ae-8b6640694e3d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "76eacfa3-76ed-445e-8d25-56886d3c8d65", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8dbb8e61-5566-48f6-8a1c-ea850f244094", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35da0d8b-130e-49a8-be66-48d6f4433015", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d094fa8f-7ea2-411a-8d2e-c3d7b473d068", + "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": { + "url": { + "path": [ + "sp-config", + "import", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4140fb53-f83c-4ec4-9f3c-ab4a8f4ea199", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "import", + ":id", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "config-objects", + "description": "", + "item": [ + { + "id": "ca3ef1d8-af14-4a37-967d-6592b9d6ae45", + "name": "Get config object details", + "request": { + "name": "Get config object details", + "description": { + "content": "This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain \"importUrl\" and \"exportUrl\" are available for export/import.", + "type": "text/plain" + }, + "url": { + "path": [ + "sp-config", + "config-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "58cf72f6-6d57-4999-8efc-bb9921ef1bb8", + "name": "Object configurations returned successfully.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "config-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"objectType\": \"\",\n \"resolveByIdUrl\": {\n \"url\": \"\",\n \"query\": {}\n },\n \"resolveByNameUrl\": [\n {\n \"url\": \"\",\n \"query\": {}\n },\n {\n \"url\": \"\",\n \"query\": {}\n }\n ],\n \"exportUrl\": {\n \"url\": \"\",\n \"query\": {}\n },\n \"exportRight\": \"\",\n \"exportLimit\": \"\",\n \"importUrl\": {\n \"url\": \"\",\n \"query\": {}\n },\n \"importRight\": \"\",\n \"importLimit\": \"\",\n \"referenceExtractors\": [\n \"\",\n \"\"\n ],\n \"signatureRequired\": false\n },\n {\n \"objectType\": \"\",\n \"resolveByIdUrl\": {\n \"url\": \"\",\n \"query\": {}\n },\n \"resolveByNameUrl\": [\n {\n \"url\": \"\",\n \"query\": {}\n },\n {\n \"url\": \"\",\n \"query\": {}\n }\n ],\n \"exportUrl\": {\n \"url\": \"\",\n \"query\": {}\n },\n \"exportRight\": \"\",\n \"exportLimit\": \"\",\n \"importUrl\": {\n \"url\": \"\",\n \"query\": {}\n },\n \"importRight\": \"\",\n \"importLimit\": \"\",\n \"referenceExtractors\": [\n \"\",\n \"\"\n ],\n \"signatureRequired\": false\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5df15342-15e9-40e1-af1e-d73c0fdd1c4e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "config-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bb554f05-e018-4d73-a9ca-55313983dc5e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "config-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "919fc720-c8b7-4050-b02d-3b4d783835ed", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "config-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5fb50034-d05a-45ce-bf0c-7facafa794ce", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "config-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2564b56-bb9a-49c9-8ebc-c46a8c20a478", + "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": { + "url": { + "path": [ + "sp-config", + "config-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2842dda4-9d48-499c-bf9c-38dbcda12570", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sp-config", + "config-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "sources", + "description": "", + "item": [ + { + "id": "aa24b3bf-5f70-4227-8a19-2df533d595d3", + "name": "Lists all sources in IdentityNow.", + "request": { + "name": "Lists all sources in IdentityNow.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, name, owner.name, healthy, status**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d84cf456-d516-4d66-8947-ffe1f54bc369", + "name": "List of Source objects", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, name, owner.name, healthy, status**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"GROUP_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n },\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"SHAREPOINT_TARGET\",\n \"GROUP_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da299f70-8960-498f-9c3e-4f3ba8efbdfa", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, name, owner.name, healthy, status**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "796c2ba7-ab7e-452d-82a0-96aa6a70e2c9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, name, owner.name, healthy, status**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "054ddd58-397a-4f6c-91b8-6bc46993c51b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, name, owner.name, healthy, status**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0486290b-4a16-4e90-9f82-aa2526ac2271", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, name, owner.name, healthy, status**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30ab2d0a-fa3f-4311-967d-e06a400344cd", + "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": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, name, owner.name, healthy, status**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6496f4b6-8916-4984-8992-175df4298e6c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, name, owner.name, healthy, status**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "747d91c2-19be-433c-b893-33cbd2645b20", + "name": "Creates a source in IdentityNow.", + "request": { + "name": "Creates a source in IdentityNow.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "275eced0-51b3-40db-8a1c-03f632ea83b5", + "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": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5d3870f-a967-47d6-966e-18bb14255be2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "71cb5b61-995e-4de2-8932-c4ee2bc431bf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3d64a74f-e02a-46ed-8188-12c5f3c992d2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f391fa2-af70-4ff2-af70-a29fd15de8f7", + "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": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4c9334b7-7f72-4f13-934a-8ed1ec89cf49", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "bb33df89-484e-4947-a977-efb1190dc432", + "name": "Get Source by ID", + "request": { + "name": "Get Source by ID", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c783b5ff-cfd8-409d-bcd0-97881d153afd", + "name": "A Source object", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab483f59-35b4-47ee-a940-5eb5412666c5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0bfed439-d0d1-4d59-9417-38254c9ad5a5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fc91b73d-526a-4ce6-aaf5-d931a98312ed", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42d5a6b0-326a-416b-a830-5fb31164f6a1", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d63a2eb3-bc48-426a-a67b-ae94623be2ef", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf4e1ad2-a27c-4848-a867-0e482a41fb63", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "67f24d49-e56f-42f6-9390-6dad53985348", + "name": "Update Source (Full)", + "request": { + "name": "Update Source (Full)", + "description": { + "content": "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", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "adf6f5f4-1aad-45b3-882f-b7b8f22c84b6", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "598fc568-ad57-44bc-b16a-36bab365b7f1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c92dfd21-23f9-49c8-9791-ba54269c72ae", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa902c4b-07ed-4ae8-a23a-df222d8896a0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "92159ddc-4a19-4c0c-80ce-82de0fbf45a6", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5ab795c-03cd-4ca3-b5af-4d357b01242f", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e8fd0083-73a0-4479-ac8c-0f9430155c6e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a08e3b35-9ad7-4c33-b35e-e288ffcc919b", + "name": "Update Source (Partial)", + "request": { + "name": "Update Source (Partial)", + "description": { + "content": "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* 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", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "da4db004-ee27-4699-a6d1-4ada42ee0e7a", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "608b5c3b-db1b-417e-a528-1e6689aa7566", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7507db52-cbd0-449e-9d15-564154f796ae", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34a27646-4557-445e-b97a-5ac54797ddab", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d20bfecb-0412-46a6-8e74-8c8bcabaa01b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2801fbc2-4b8c-47ed-984e-8f0881dbe6d7", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7448b6e8-20f3-492f-8168-9bda6cbfb623", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8970a8f6-a43f-496c-a52f-bd85773bff89", + "name": "Delete Source by ID", + "request": { + "name": "Delete Source by ID", + "description": { + "content": "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}`", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "39fd6888-07da-4d58-ac16-3fdaba9ed753", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "43fc0b68-c567-400b-8e69-acf7ff4fb3a6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6e243afa-6ba7-4601-9522-9c4c5160cc00", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d4ed383-513b-4ee6-83ea-c08a4f71f435", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9a17065-6da0-4648-ad22-d7a2c2ab3977", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24a293e6-6850-4a8e-8522-a4774e675dd6", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab3aeff1-47a3-4cad-b7fd-1709d4a4de50", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "attribute-sync-config", + "description": "", + "item": [ + { + "id": "fffa5ab7-d1a0-4e02-a773-d978788c1d74", + "name": "Attribute Sync Config", + "request": { + "name": "Attribute Sync Config", + "description": { + "content": "This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "590147b3-a389-4be2-a4a4-baf676ab6755", + "name": "Attribute synchronization configuration for a source", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c1fb1864-b4bf-491a-8391-25c49afdc9e5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "78880868-e972-405c-9fc3-958a64696f47", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3954dbb-228b-4f1d-95b6-abe73200e018", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "58c8b065-23c3-4ad2-9f1d-cf18b0da7441", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "672fe7e3-6e91-4853-8e33-5bc2121c8828", + "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": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b451a865-d9dc-417b-8c28-c92d29f600db", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f280b8ad-8bb1-471a-9f9b-eebbc30ed765", + "name": "Update Attribute Sync Config", + "request": { + "name": "Update Attribute Sync Config", + "description": { + "content": "Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error.\n \nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c6a6f2be-da99-4e14-8a2f-6b19d58baa8f", + "name": "Updated attribute synchronization configuration for a source", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3a631a85-d62e-475c-b12a-1952190f192e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "387b3867-8e38-45d0-975d-145ab62e802c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42704b74-37f7-4d42-b4da-a8b880719cb1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9fa7313b-78f7-4d75-b93d-fe751518ef1f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5edf40d1-5604-447f-8b97-b438943b1b54", + "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": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8f08726-b2df-4b4b-b18c-bf0a20f8428a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "attribute-sync-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"enabled\": \"\",\n \"target\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "connectors", + "description": "", + "item": [ + { + "name": "source-config", + "description": "", + "item": [ + { + "id": "e2f6d3d6-e057-401c-9f1a-f84866f48c65", + "name": "Gets source config with language translations", + "request": { + "name": "Gets source config with language translations", + "description": { + "content": "Looks up and returns the source config for the requested source id after populating the source config values and applying language translations.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "connectors", + "source-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "ru" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3abad9d2-1264-43a8-b290-813496f84dcb", + "name": "A Connector Detail object", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "connectors", + "source-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "ru" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"sourceConfigXml\": \"\",\n \"sourceConfig\": \"\",\n \"directConnect\": \"\",\n \"fileUpload\": \"\",\n \"uploadedFiles\": \"\",\n \"connectorMetadata\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "39f2d1be-9330-4867-b76f-45c7cdea75da", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "connectors", + "source-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "ru" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c93c2516-2e02-49ed-b0dd-e92ef9042ff4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "connectors", + "source-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "ru" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6be3fd33-2688-4f16-8461-3c78dd066ed9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "connectors", + "source-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "ru" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e93bc50-6e1d-47a1-8d80-7fb5199f132b", + "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": { + "url": { + "path": [ + "sources", + ":id", + "connectors", + "source-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "ru" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "64bd7995-80c3-457d-a0c4-8e839e534548", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "connectors", + "source-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The locale to apply to the config. If no viable locale is given, it will default to \"en\"", + "type": "text/plain" + }, + "key": "locale", + "value": "ru" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "schemas", + "description": "", + "item": [ + { + "name": "accounts", + "description": "", + "item": [ + { + "id": "b786e270-3f37-4c2c-be4b-58842aae40e4", + "name": "Downloads source accounts schema template", + "request": { + "name": "Downloads source accounts schema template", + "description": {}, + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "769ad959-e1ce-4a18-887c-e241d8287b7a", + "name": "Successfully downloaded the file", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{\n \"example\": \"id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate\"\n}", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "3d968b5a-f406-4c74-ae20-c08b4c650504", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49ce4a14-f7b3-4f17-8f67-2cd0ff4a33f8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "21ab14e0-8c32-4a82-b64d-e3b5f0642e9d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "86b4936b-e45f-43b6-b732-16383675bf35", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "88a435d4-353e-4350-8bd5-274a2064b8ec", + "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": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "011e0873-0212-4fb1-a60c-c8c5fe60af7c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "248da784-cc73-4094-a70b-577ace62a235", + "name": "Uploads source accounts schema template", + "request": { + "name": "Uploads source accounts schema template", + "description": { + "content": "This API uploads a source schema template file to configure a source's account attributes.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "9c80fedb-65b8-4b68-be33-c4640dba18b7", + "name": "Successfully uploaded the file", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "590df9ca-dd3a-44c6-9b69-6fb9eec0e60f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48bde1c4-0bce-45b7-8c1c-bbc7fd550ac6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e4adca00-2758-4de8-afe8-adee7f43d333", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ed5aba2-f0a3-40e6-a3f7-fc8f5cb5859d", + "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": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e44ca4f-a782-4b94-ae6e-a3bda2f50132", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "entitlements", + "description": "", + "item": [ + { + "id": "c7d6318c-40ad-496d-a856-f33c6fe4ff84", + "name": "Downloads source entitlements schema template", + "request": { + "name": "Downloads source entitlements schema template", + "description": {}, + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4c3000e3-fa16-4663-8e32-cc294aad505c", + "name": "Successfully downloaded the file", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{\n \"example\": \"id,name,displayName,created,description,modified,entitlements,groups,permissions\"\n}", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "70a93e6b-20a1-4501-9736-b3127deee9a9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d38fc6d-4441-4aa7-82cb-4ef0d28bfc9b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2269818b-da39-4eef-92f9-4ba4f496f6c0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b42bba99-0591-43d8-b875-97ac9cb45301", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fc886e16-d50d-45aa-88e3-ee09dd440e0e", + "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": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65c395c2-ae53-4ad6-9e72-89b3204fb079", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "6ace5cc6-5349-4dae-add5-cbf7ecd7f743", + "name": "Uploads source entitlements schema template", + "request": { + "name": "Uploads source entitlements schema template", + "description": { + "content": "This API uploads a source schema template file to configure a source's entitlement attributes.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "004c1e9f-6b48-4c90-9660-795176d52249", + "name": "Successfully uploaded the file", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a0fe65d-1079-480a-851c-1aa246c88059", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c72d69b6-faa5-44a6-8fe6-c2f9e29e8094", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "437f7270-cec8-4851-a4da-54a9e3a8fb4c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4121d3b-ba9c-4262-a60e-b71a144a21bc", + "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": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "88980ef2-c5a2-4e63-91dd-857742de84e9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "synchronize-attributes", + "description": "", + "item": [ + { + "id": "5bb8302b-f350-4cc6-8338-0df490ee6fc1", + "name": "Synchronize single source attributes.", + "request": { + "name": "Synchronize single source attributes.", + "description": { + "content": "This end-point performs attribute synchronization for a selected source.\nA token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "6bda649a-9bc6-4761-a1d7-b3ccdd3f358d", + "name": "A Source Sync job", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"status\": \"ERROR\",\n \"payload\": {\n \"type\": \"\",\n \"dataJson\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ba136d6a-8c98-48b9-b394-57cae020eecb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b72e79e9-6ee5-4662-b16a-8035f4309686", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a9db3112-afbf-4024-bc58-75137b5b65c4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ce2d3828-d475-4dc5-87a6-717d212eacf9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5307ce4d-b891-4787-9de1-0b3cdc608ea9", + "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": { + "url": { + "path": [ + "sources", + ":id", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca9580b3-484e-4953-805b-3c07b6154219", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "synchronize-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "entitlement-request-config", + "description": "", + "item": [ + { + "id": "c2cdc34e-504b-4e32-8cd4-22f234d381c6", + "name": "Get Source Entitlement Request Configuration", + "request": { + "name": "Get Source Entitlement Request Configuration", + "description": { + "content": "This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.\n\nAccess request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.\n- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.\n- However, the entitlement-level configuration (if defined) overrides this source-level configuration.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "key": "id" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "09b507c3-cbbb-43bd-a427-217e95bb4104", + "name": "Source Entitlement Request Configuration Details.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c1ad030b-e3e4-42e9-b11e-9ec556d0d2d4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1633caff-e984-4eac-8ae8-eff875e037c4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75fbbd7a-7183-4327-a86c-f226a8062ede", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f7b4c007-4050-4a15-97dc-196e70c2d75b", + "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": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b3ce125c-8faa-4f89-adf0-57fdaa3521e2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "71f22095-79cb-455c-bf8d-10f4467c51a4", + "name": "Update Source Entitlement Request Configuration", + "request": { + "name": "Update Source Entitlement Request Configuration", + "description": { + "content": "This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.\n\nAccess request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.\n- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.\n- However, the entitlement-level configuration (if defined) overrides this source-level configuration.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "key": "id" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e1759599-7700-44a7-a761-eeebd7b9b1dd", + "name": "Source Entitlement Request Configuration Details.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1ce6edf-aed8-4f4a-8ba3-f7286bd72f05", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "46796510-53d8-4780-9b97-2494d7ac7072", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d604219c-3f87-466c-808b-9893ce9ead41", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "84e76d65-4901-4f9a-ab86-8a19ce7f4e98", + "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": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f738ce60-0f8e-4c18-aaf1-b7f7b2eed79a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "entitlement-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accessRequestConfig\": {\n \"approvalSchemes\": [\n {\n \"approverType\": \"ENTITLEMENT_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ],\n \"requestCommentRequired\": false,\n \"denialCommentRequired\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "{sourceId}", + "description": "", + "item": [ + { + "name": "connector", + "description": "", + "item": [ + { + "name": "check-connection", + "description": "", + "item": [ + { + "id": "e4ca776e-c3be-40dd-8f4b-de2f706a069f", + "name": "Check connection for source connector.", + "request": { + "name": "Check connection for source connector.", + "description": { + "content": "This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "check-connection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "decd45a1-df91-4b22-b040-e29e8ee05d7c", + "name": "The result of checking connection to the source connector with response from it.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "check-connection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"FAILURE\",\n \"elapsedMillis\": \"\",\n \"details\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "923ae70b-722b-4988-989c-2705654db912", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "check-connection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "313a7a6b-4973-49db-a508-4d5ffc40d9a3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "check-connection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b60fdce-d4dd-466c-8a22-d34413e2bb5c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "check-connection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb4f215f-3e87-4649-aa93-ba9df8c8b1d2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "check-connection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0583050e-4397-4097-8ca2-3b5cd021c572", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "check-connection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e607773d-efe8-455c-baa5-8d9015402a18", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "check-connection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "peek-resource-objects", + "description": "", + "item": [ + { + "id": "fd5c1e62-d35f-4bd9-bde1-bed66e6eb01c", + "name": "Peek source connector's resource objects", + "request": { + "name": "Peek source connector's resource objects", + "description": { + "content": "Retrieves a sample of data returned from account and group aggregation requests.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "peek-resource-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectType\": \"account\",\n \"maxCount\": 25\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e4fa8f41-824a-4beb-95a2-23439e429d42", + "name": "List of resource objects that was fetched from the source connector.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "peek-resource-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectType\": \"account\",\n \"maxCount\": 25\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"objectCount\": \"\",\n \"elapsedMillis\": \"\",\n \"resourceObjects\": [\n {\n \"instance\": \"\",\n \"identity\": \"\",\n \"uuid\": \"\",\n \"previousIdentity\": \"\",\n \"name\": \"\",\n \"objectType\": \"\",\n \"incomplete\": \"\",\n \"incremental\": \"\",\n \"delete\": \"\",\n \"remove\": \"\",\n \"missing\": [\n \"\",\n \"\"\n ],\n \"attributes\": {},\n \"finalUpdate\": \"\"\n },\n {\n \"instance\": \"\",\n \"identity\": \"\",\n \"uuid\": \"\",\n \"previousIdentity\": \"\",\n \"name\": \"\",\n \"objectType\": \"\",\n \"incomplete\": \"\",\n \"incremental\": \"\",\n \"delete\": \"\",\n \"remove\": \"\",\n \"missing\": [\n \"\",\n \"\"\n ],\n \"attributes\": {},\n \"finalUpdate\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b869cf3e-3ece-413f-886e-080440d147e2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "peek-resource-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectType\": \"account\",\n \"maxCount\": 25\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5199fac-4d59-47f7-8287-68a892bd99ee", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "peek-resource-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectType\": \"account\",\n \"maxCount\": 25\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48602aed-6eda-4da8-8227-52c6386a418a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "peek-resource-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectType\": \"account\",\n \"maxCount\": 25\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "56469f00-1fb1-4c36-9597-136309a0c26a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "peek-resource-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectType\": \"account\",\n \"maxCount\": 25\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30dd4728-0d3a-401e-a195-5dbd3897baf9", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "peek-resource-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectType\": \"account\",\n \"maxCount\": 25\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b8297e91-9998-455c-ad2b-59082b57c904", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "peek-resource-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectType\": \"account\",\n \"maxCount\": 25\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "ping-cluster", + "description": "", + "item": [ + { + "id": "ce31a443-9b4b-4340-a2e8-610e97eae79c", + "name": "Ping cluster for source connector", + "request": { + "name": "Ping cluster for source connector", + "description": { + "content": "This endpoint validates that the cluster being used by the source is reachable from IdentityNow.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "ping-cluster" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "aeeaff5d-06ae-495f-a9d4-dba74df9f12e", + "name": "The result of pinging connection with the source connector.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "ping-cluster" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"FAILURE\",\n \"elapsedMillis\": \"\",\n \"details\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "391a9948-cffc-4d26-9105-f2959a24abd4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "ping-cluster" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e377757b-6a5a-4164-8dd4-810b65ab192c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "ping-cluster" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11125e93-35e4-4bb4-9ffd-74a33e2ad35f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "ping-cluster" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "46f3097b-d7fb-4324-9fad-e4907cffb078", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "ping-cluster" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d9315add-79e4-4b4a-bc77-6b8c31eab171", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "ping-cluster" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11703ce8-bf3a-4063-900f-f1ae1224b32c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "ping-cluster" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "test-configuration", + "description": "", + "item": [ + { + "id": "044b4392-ab83-437a-bd85-b495ead747fd", + "name": "Test configuration for source connector", + "request": { + "name": "Test configuration for source connector", + "description": { + "content": "This endpoint performs a more detailed validation of the source's configuration that can take longer than the lighter weight credential validation performed by the checkConnection API.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "test-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "86718cce-0ef7-4d1f-8d1e-a18732839e3f", + "name": "The result of testing source connector configuration with response from it.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "test-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"FAILURE\",\n \"elapsedMillis\": \"\",\n \"details\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9720a1ab-3bc2-427a-9b9f-f1461fec7c35", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "test-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49cb52ed-1200-44b3-9992-86488dcb2e59", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "test-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "547572ba-3b03-4b7f-87a4-dba3450f83ce", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "test-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d831e964-9562-4d0e-b12c-830670fa69d5", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "test-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97ae1899-2119-42a7-924e-923a16e11a7d", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "test-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "049b7d16-bf6e-45b1-8c19-b3310a22f3db", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "connector", + "test-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "provisioning-policies", + "description": "", + "item": [ + { + "id": "21233d12-9eb7-46c1-91f3-20d228fb1ae2", + "name": "Lists ProvisioningPolicies", + "request": { + "name": "Lists ProvisioningPolicies", + "description": { + "content": "This end-point lists all the ProvisioningPolicies in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "23a5c74b-91f2-4fec-81fd-25434a08c120", + "name": "List of ProvisioningPolicyDto objects", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab29bbd9-4a64-4973-a7f3-be37d9c2125b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aff7dc66-f940-4480-8c59-93a0d010e5d6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "224d77ed-b085-4545-b370-bfe375797a36", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5c84a6d9-2b00-4f1a-9520-d467750419be", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f421350c-2693-4a81-803f-9f4006a46d8c", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "221c2edf-3ff6-41a1-8960-25a3a2eb3590", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ac0afee5-4ce9-420f-8ce6-028b6e47f846", + "name": "Create Provisioning Policy", + "request": { + "name": "Create Provisioning Policy", + "description": { + "content": "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.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "cd466850-7e7d-4b52-b05b-226aeefd91e6", + "name": "Created ProvisioningPolicyDto object", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "332c773d-ceee-4ec9-b933-c87e12818ee5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a507156-d2e3-4314-9bd2-140d4d9702d4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca12722d-f5f1-4970-a481-9537170abb13", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c430958-e745-410c-8a4e-daf09ec97744", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "379ed227-a5e5-442f-bbf0-8100bd85b257", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57d11e90-8bdd-4f02-96da-2e367c750936", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{usageType}", + "description": "", + "item": [ + { + "id": "53946820-cb93-45ab-8efb-5a4653a3b985", + "name": "Get Provisioning Policy by UsageType", + "request": { + "name": "Get Provisioning Policy by UsageType", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "DELETE_GROUP", + "key": "usageType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1f1fb81a-d20f-436e-8c5f-5b2c7c6c42f7", + "name": "The requested ProvisioningPolicyDto was successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf21f931-ae83-4ca1-82fc-9a7d7cca9df7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "43166592-3801-4698-ad0c-3bb76e705c50", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "918ae808-d93e-401b-a4ca-e1c1d757cfe7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5ac85dc8-4a86-4d34-925a-546ebfa0297a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e723c8c0-7211-416f-ade0-b95321c4c163", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0b00d85-2562-4a1f-9460-20c9b854cd7c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b2709a5c-8cdb-4c42-8453-151918e0d03f", + "name": "Update Provisioning Policy by UsageType", + "request": { + "name": "Update Provisioning Policy by UsageType", + "description": { + "content": "This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "DELETE_GROUP", + "key": "usageType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "60dc51ae-d41c-4c43-8f34-e04f0af19099", + "name": "The ProvisioningPolicyDto was successfully replaced.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f99ef32c-4a9c-479b-897e-5bb1e96b7879", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3dccceb3-e539-4af8-8335-6b76a6905014", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e469ed0-15b0-4f48-a287-baa31481935b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b33c5db-58a2-492b-89a0-492dfe22db92", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eeec2ee6-3e5e-4623-b53f-0e036b134bc9", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d43be74e-c973-4f6d-9778-a2bb74f79a55", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a35f1abb-ce89-400f-a6bf-e4f01a13eaeb", + "name": "Partial update of Provisioning Policy", + "request": { + "name": "Partial update of Provisioning Policy", + "description": { + "content": "This API selectively updates an existing Provisioning Policy using a JSONPatch payload.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "DELETE_GROUP", + "key": "usageType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a05c11a8-e9d9-4b3a-a054-df451082ea44", + "name": "The ProvisioningPolicyDto was successfully updated.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UNASSIGN\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17ec6422-b549-4445-bc5c-d94ec8a3432c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d64fe065-912c-49d2-982f-1e20663cb991", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c759e51-d495-4700-add8-cec0bd0e3cb4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45953b65-cdd7-4b0c-b4e5-bfd8432ed0ec", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9b060614-fd88-41b8-8d95-667ea9a570dc", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "00d93174-f179-4d4b-b4c3-562801d3f144", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f6fa824c-8094-4239-b109-5f972f5d01e4", + "name": "Delete Provisioning Policy by UsageType", + "request": { + "name": "Delete Provisioning Policy by UsageType", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "DELETE_GROUP", + "key": "usageType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "e9c2d3ce-aa57-4f48-99b7-2b0288045e6b", + "name": "The ProvisioningPolicyDto was successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "9eae3c4c-93c8-412d-bd2c-c318ab51c460", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "72ffc4e3-e168-46af-a69f-621e1ff7d1ab", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "54aa33ab-0d98-4ad7-acb1-bf244ff5c278", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "55fbc87d-618c-4518-999b-90679ffd7e17", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db876362-e352-4984-81f8-34ac78740629", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c5ebcb2-4985-47fe-a7b2-90fc8ae25155", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "bulk-update", + "description": "", + "item": [ + { + "id": "786c6177-39c9-4946-b0aa-781c2abb316e", + "name": "Bulk Update Provisioning Policies", + "request": { + "name": "Bulk Update Provisioning Policies", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e66100cc-b640-45bc-ab4b-358e57e61610", + "name": "A list of the ProvisioningPolicyDto was successfully replaced.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3f065de-8ea2-4fb4-a316-3a3cd53fa1bc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "43502a7d-d041-4bfe-b232-d3125a092730", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d25d896-e1be-4f09-8afd-b30fb058ddc7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b315bb3-7d60-40f7-b663-c38abd6246e4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "19e42daa-bf55-48e7-8263-23a11b7dad55", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01324947-d9db-456e-a1cd-77cd20fcc790", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "schemas", + "description": "", + "item": [ + { + "id": "af57b9ea-fc32-4218-99a7-36dbcd89fd48", + "name": "Lists the Schemas that exist on the specified Source in IdentityNow.", + "request": { + "name": "Lists the Schemas that exist on the specified Source in IdentityNow.", + "description": {}, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "da0f38b6-d62f-4d0b-b4f0-d477bc5b5f44", + "name": "The Schemas were successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"ADDITIONAL_ACCOUNT_REQUEST\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"PROVISIONING\",\n \"SHAREPOINT_TARGET\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9408dd74-4fbd-419c-b692-eea5d7cbdf4e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da8eadbd-0efb-4daf-9b39-f434c05a4095", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d1a789a-f352-4238-b7b4-5e3529332de0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e38895d-2a24-4c79-bc99-f9a564b79caf", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aaa3f31f-8894-43ca-adae-e30539e0ac3e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a2754419-ba99-46f4-9fb7-e225f9d2abb3", + "name": "Creates a new Schema on the specified Source in IdentityNow.", + "request": { + "name": "Creates a new Schema on the specified Source in IdentityNow.", + "description": {}, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "60e058af-a392-420b-b9bd-123b40743814", + "name": "The Schema was successfully created on the specified Source.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ffea1b86-489a-47f4-96dc-f1d83622bbed", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62f75899-adef-46e3-9a4b-8200940ec32e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e6f1c34-3ae8-447e-90f2-109f391a8414", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2add44a6-0fa2-4707-875d-b20236b14416", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3b7dec7-e552-4ec2-9c58-d9a829dc21e4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{schemaId}", + "description": "", + "item": [ + { + "id": "761d22f1-b69c-40a9-8654-debf5cc35eae", + "name": "Get Source Schema by ID", + "request": { + "name": "Get Source Schema by ID", + "description": { + "content": "Get the Source Schema by ID in IdentityNow.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "schemaId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d2781573-84b2-4c97-bd8c-81ae7309d049", + "name": "The requested Schema was successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "27a1f4e9-2dbf-4420-9c8e-5ca712182792", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7e465ce-f84c-4be6-a649-900833c60a6b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a995ef2c-a921-408a-82e6-3bf1897cdfec", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "790c7c4e-d139-4bee-92ae-ad7cf16bf605", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67914a5b-9b5c-4911-9a9b-0658d685cf04", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a1ee798-c1c3-4f0f-b8cb-4fbfc12e1fbc", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a08b623a-dff8-48ec-9df8-7925c5f472ca", + "name": "Update Source Schema (Full)", + "request": { + "name": "Update Source Schema (Full)", + "description": { + "content": "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* id\n* name\n* created\n* modified\nAny attempt to modify these fields will result in an error response with a status code of 400.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "schemaId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3cb4329d-7599-4047-9b90-783924a913c3", + "name": "The Schema was successfully replaced.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42bc26ca-dc86-4163-9f46-8560f388fe4c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3c0e51e-a012-4025-96bf-83bb475d5668", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4405edb8-72e0-478e-b797-7db23398dd79", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8eead64d-cbf9-425a-9b51-45e9e773c253", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5b55471-0f3d-4ec6-a8ae-947dc9c45fb7", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81ad6dd1-7905-40c3-a235-ad52eab3a5b9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9091a443-e158-41c5-938a-8d2baabd7cfc", + "name": "Update Source Schema (Partial)", + "request": { + "name": "Update Source Schema (Partial)", + "description": { + "content": "Use this API to selectively update an existing Schema using a JSONPatch payload. \n\nThe following schema fields are immutable and cannot be updated:\n\n- id\n- name\n- created\n- modified\n\n\nTo switch an account attribute to a group entitlement, you need to have the following in place:\n\n- `isEntitlement: true`\n- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:\n```json\n{\n \"name\": \"groups\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180887671ff8c01767b4671fc7d60\",\n \"name\": \"group\"\n },\n \"description\": \"The groups, roles etc. that reference account group objects\",\n \"isMulti\": true,\n \"isEntitlement\": true,\n \"isGroup\": true\n}\n```\n", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "schemaId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "9d053aaa-0703-4648-9f9e-b6c40ac97164", + "name": "The Schema was successfully updated.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"NO_GROUP_PERMISSIONS_PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"LONG\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"\",\n \"type\": \"INT\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMulti\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a52a8b2-d443-4909-967d-613a06b31457", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6cec01e2-ff6a-4c78-a24e-da348df4b1e6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3bef254e-a3b1-44fb-a71e-e0ec4a7a649f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ba293642-bede-4b88-aa6d-ae52c9ff2499", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c33198f8-31a4-4fd8-b464-55d9aff7d46b", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48e866ec-d142-4bd1-a9b3-c147152ac92c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d0936856-1f19-420a-8118-73931fe7b4f8", + "name": "Delete Source Schema by ID", + "request": { + "name": "Delete Source Schema by ID", + "description": {}, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "schemaId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "b014482d-5c4a-4347-8e17-e2ffc971ced9", + "name": "The Schema was successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "ba9800dc-3399-4fc9-b26d-d5200f85189d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ded8f604-c0cf-497a-9a20-436ed9307279", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5ef8852b-c555-447b-85e0-0ce93b9976f6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d632afc-f36d-4bd7-81ad-a352e3338f1b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "087e81f7-af0a-4113-85c9-ea8da4b0a223", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f653804f-b6b5-4ac1-a737-826a7816fa3a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "upload-connector-file", + "description": "", + "item": [ + { + "id": "fe5a5e40-ab5d-4ead-98a6-c9569191f695", + "name": "Upload connector file to source", + "request": { + "name": "Upload connector file to source", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "4ff3f00b-cc3a-4a16-b116-12a848a8f1ae", + "name": "Uploaded the file successfully and sent all post-upload events", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"UNLOCK\",\n \"UNLOCK\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5e39b19-59c3-4f53-82ea-6b82062787c8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "88327d58-4968-4178-9921-590b4a0a18b5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "954e7f07-8e91-4752-9cd6-40e9979d1724", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e7559192-feb4-4ef5-a357-a4a607890e3c", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5608a8c0-db83-40f0-baff-baf0a0408cc4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "tagged-objects", + "description": "", + "item": [ + { + "id": "09629b10-b62c-4f12-9bd6-3d0de18d9a4f", + "name": "List Tagged Objects", + "request": { + "name": "List Tagged Objects", + "description": { + "content": "This API returns a list of all tagged objects.\n\nAny authenticated token may be used to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "52320685-b21f-4384-8cf2-c901a297a4b7", + "name": "List of all tagged objects.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"objectRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"objectRef\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b7e2f77d-f89f-4add-b35d-b07ab863a388", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b51c25e6-e11e-469b-b62d-1bd7551d8706", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a806399d-3e22-4c8a-aec1-809c224f8738", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b718d79f-2695-44b1-a2bf-365d8d96d111", + "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": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "658d3a2a-9eea-4273-97bd-e0b3b7daa5ae", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0f81f4e1-52cd-4758-80f0-f2bd48759717", + "name": "Add Tag to Object", + "request": { + "name": "Add Tag to Object", + "description": { + "content": "This adds a tag to an object.\n\nAny authenticated token may be used to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e114d9e2-42a1-44ef-8665-ca9693675079", + "name": "Created.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "8a63170d-d74f-4b08-8afe-58cf25ef0258", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "15b92915-64a7-4cbc-99c6-05f93bfdcc84", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "47474be4-246f-4381-8be4-2e6f856b348b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a7533b1-5e0c-42e8-bbd9-48684dea7b44", + "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": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40d74f91-f192-4316-bb86-c514fd2ade28", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{type}", + "description": "", + "item": [ + { + "id": "d72ac8b0-ffee-49f6-bfc4-1b98b157790b", + "name": "List Tagged Objects", + "request": { + "name": "List Tagged Objects", + "description": { + "content": "This API returns a list of all tagged objects by type.\n\nAny authenticated token may be used to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "ROLE", + "key": "type", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1d49802a-36df-413d-b98a-fa1075554c3a", + "name": "List of all tagged objects for specified type.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"objectRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"objectRef\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e977817-107b-4738-9d84-e1f5810fd7f2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8fbbd4fa-cb7f-400c-8382-e1df8101a1d5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "209a79b8-bbe4-48a2-af1a-c511ac83e441", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96d8c12c-421e-47a1-ad92-3f029bddc5ea", + "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": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7ea1a57-86c2-4d58-baf6-04319d8f28bf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "471d25b0-d79e-4905-8066-1e5c31955848", + "name": "Get Tagged Object", + "request": { + "name": "Get Tagged Object", + "description": { + "content": "This gets a tagged object for the specified type.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "ROLE", + "key": "type", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "54205836-8c6c-4343-8e09-884ee49f26a1", + "name": "Tagged object by type and ID.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c9771422-4a3a-4dd2-9a58-b84e1534f1f4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d487175-f6bf-4220-8f10-b5e8305f231e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4582180b-a688-4c70-ad14-ae7dd8808ae2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13b4b1fd-03ef-43a1-8bbb-23c6599e1474", + "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": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63d7f75e-780a-46e4-994e-c6456ced183c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "eb52e58c-dd26-48d8-b976-26cf56cd2de7", + "name": "Update Tagged Object", + "request": { + "name": "Update Tagged Object", + "description": { + "content": "This updates a tagged object for the specified type.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "ROLE", + "key": "type", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6a7d511c-a645-4ee3-883b-a3e24282da72", + "name": "Tagged object by type and ID.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "06269b6d-8785-4d5d-bb2a-3ad555e37bc7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2d6e5997-af44-4acb-923e-4001941f6a29", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "826f2f1d-5864-4cd4-91c2-2df3cbe14d20", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ed20692-527e-46c1-8b63-2eb7a1fc31a8", + "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": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7bd2e2bf-ad83-4676-81f5-1d0444eee153", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4ef3466f-e64e-4cad-a7e7-97beca37ad10", + "name": "Delete Tagged Object", + "request": { + "name": "Delete Tagged Object", + "description": { + "content": "This deletes a tagged object for the specified type.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "ROLE", + "key": "type", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "f9bebe05-4fe0-438f-8325-64939d727afc", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "3534341c-1e03-4420-935e-359812369c50", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "280c44e4-9c15-483f-a73e-3410ec42e9cc", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "68365aa1-c054-49bc-afac-5c7aae33de12", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e4f2b37b-20fa-4406-be10-a0f1c2416177", + "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": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c181211-83de-4a28-b836-fc742268a635", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-add", + "description": "", + "item": [ + { + "id": "586edfa4-cbad-438e-9c8c-2ebc31679a32", + "name": "Tag Multiple Objects", + "request": { + "name": "Tag Multiple Objects", + "description": { + "content": "This API adds tags to multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c9ac5d57-5f6e-4023-8f39-5f46ee6ceb5c", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8ade0886-1acf-46a1-9e8d-11b4bb7f6642", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16dc9fe0-aa79-4351-9e19-d48e054129ec", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73453aa7-7c45-475a-a18f-6f782bc36deb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e4196d6-57c7-4d45-8e60-823b7d7e02ff", + "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": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f0ab0ae-a50d-4548-8d94-52d1af71464d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "bulk-remove", + "description": "", + "item": [ + { + "id": "4a9df7e0-b200-405a-bf2c-3d5a29f03675", + "name": "Remove Tags from Multiple Objects", + "request": { + "name": "Remove Tags from Multiple Objects", + "description": { + "content": "This API removes tags from multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2ea87213-7de9-4f42-8c04-2f37c3b559e1", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "62ac639b-cfc9-44a5-8f76-ce237fb9aac4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1f261c80-9b29-494e-8efc-b8dcf0d7c0a6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d3ee1f1-3139-45da-bd25-5073610c3098", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec026ed5-2eed-45d9-b108-a943907ddbd3", + "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": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f35ffc2e-5f3b-42b4-a880-b960ffeb2e76", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "transforms", + "description": "", + "item": [ + { + "id": "d7f53377-ac21-4ccb-a885-4b08cc7d9a2e", + "name": "List transforms", + "request": { + "name": "List transforms", + "description": { + "content": "Gets a list of all saved transform objects.\nA token with transforms-list read authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "90645558-dda7-4e9b-87aa-887890a4526a", + "name": "A list of transforms matching the given criteria.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "691c6b99-5086-4573-a53f-d422a9ce2ac6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f6e198e2-208e-40df-8cec-e046b282582b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "66948ae1-fe5a-4f3b-8a9f-b011d4c7aec6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e5b5f87-81d4-49b8-93e5-67f9d2432104", + "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": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca48fa24-1c3c-41ee-b8b3-d64b55110399", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2433a8f2-90dc-4e28-a938-85078ff8274c", + "name": "Create transform", + "request": { + "name": "Create transform", + "description": { + "content": "Creates a new transform object. Request body must include name, type, and attributes.\nA token with transform write authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6a9ef5fc-19ec-4bc5-b107-bc07de989173", + "name": "Indicates the transform was successfully created and returns its representation.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "85045de6-446c-45f6-81d8-9894caa943c7", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5357902f-a303-4a46-9886-2d7d7bcdb29a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75e723b1-3977-4f4e-ad2b-0d7e3fdee583", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0880af9d-fa2d-4604-8459-c7e456d117aa", + "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": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a73013e7-cf99-4ce6-8598-2529d5e7b15f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "de013306-8e2a-46ef-b129-bf6d9785fc50", + "name": "Transform by ID", + "request": { + "name": "Transform by ID", + "description": { + "content": "This API returns the transform specified by the given ID.\nA token with transform read authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "54be0361-b5b8-42b1-90bd-e7671a6d763d", + "name": "Transform with the given ID", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c7e1068-d5e2-4baf-a17d-2ef9332bdb56", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ee77008-c543-4c1f-8a4f-a295ac7846de", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ddd97e1-370e-4fd7-845c-d0eeafbb7f2e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f7b2a741-f435-470d-a44d-4e2c4ba8fce9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "237f7a6a-1263-4f5a-8371-e7ec579e08eb", + "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": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d4c0fdc-e626-4807-9016-809a48163f78", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "535aafc9-08c4-455c-9dcc-98c0bb6ec3ec", + "name": "Update a transform", + "request": { + "name": "Update a transform", + "description": { + "content": "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 attributes will result in an error.\nA token with transform write authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a368ad44-55ad-47b8-a067-208b0bbee3eb", + "name": "Indicates the transform was successfully updated and returns its new representation.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e64c48b0-57c6-4e8e-bdfa-8a6b12276585", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "499be2a3-0ca4-4d9a-af67-2646bfddc779", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6d7386aa-2285-49a8-b19a-496cd09c804d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "019560d4-51d0-4d72-9957-0a916715bdec", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d716548c-bcf0-482a-90d0-aa13cb39f787", + "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": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36eda5fa-4933-4aeb-a381-e250e8d1df89", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"id\": \"\",\n \"internal\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c3c27e2e-4aea-4005-9067-299049c81e97", + "name": "Delete a transform", + "request": { + "name": "Delete a transform", + "description": { + "content": "Deletes the transform specified by the given ID.\nA token with transform delete authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "23a243a5-1cf9-4893-873a-28e8547c5f4e", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "e56a1468-c9b6-475a-b11e-3fd38efec589", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42ed94d6-f847-4f08-a5f6-c28d4a4f7ddb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57fa63cf-bcba-46aa-ac6d-ff299e734571", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0169c31b-62fb-41d9-aa85-843b0de76b28", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f83c8c35-0782-4987-a1bb-09eb58a909ca", + "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": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0683089-3dbf-498d-8275-67869d3ca006", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "translation-catalogs", + "description": "", + "item": [ + { + "name": "{catalog-id}", + "description": "", + "item": [ + { + "id": "d84e6afa-5272-4081-8257-8d4e828f1d4a", + "name": "Get Message catalogs", + "request": { + "name": "Get Message catalogs", + "description": { + "content": "The getMessageCatalogs API returns message catalog based on the language headers in the requested object.", + "type": "text/plain" + }, + "url": { + "path": [ + "translation-catalogs", + ":catalog-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "access-request-recommender", + "key": "catalog-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "932de437-c062-4946-bea1-e251d463a755", + "name": "The message catalogs based on the request headers", + "originalRequest": { + "url": { + "path": [ + "translation-catalogs", + ":catalog-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"locale\": \"\",\n \"messages\": [\n {\n \"key\": \"\",\n \"format\": \"\"\n },\n {\n \"key\": \"\",\n \"format\": \"\"\n }\n ]\n },\n {\n \"locale\": \"\",\n \"messages\": [\n {\n \"key\": \"\",\n \"format\": \"\"\n },\n {\n \"key\": \"\",\n \"format\": \"\"\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "abf42163-cf5f-4209-ad44-f91363e8787f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "translation-catalogs", + ":catalog-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d489d18c-56be-49c1-a0ad-43810e2996de", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "translation-catalogs", + ":catalog-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2701fc40-654a-44b7-967b-a949428c2013", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "translation-catalogs", + ":catalog-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2bc6792-b458-425a-bca4-a4592895a62e", + "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": { + "url": { + "path": [ + "translation-catalogs", + ":catalog-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e24b8e19-37db-4494-9ae5-e72a5f34d83a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "translation-catalogs", + ":catalog-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "triggers", + "description": "", + "item": [ + { + "id": "7d3f0a12-7b59-4085-8f8e-1b67f6c9972d", + "name": "List Triggers", + "request": { + "name": "List Triggers", + "description": { + "content": "Gets a list of triggers that are available in the tenant.", + "type": "text/plain" + }, + "url": { + "path": [ + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**id** **name**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4aca9059-cd5b-45cd-ad80-8a2124ffd511", + "name": "List of triggers.", + "originalRequest": { + "url": { + "path": [ + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**id** **name**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"REQUEST_RESPONSE\",\n \"inputSchema\": \"\",\n \"exampleInput\": {\n \"accessRequestId\": \"\",\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"operation\": \"Remove\",\n \"description\": \"\",\n \"comment\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"operation\": \"Remove\",\n \"description\": \"\",\n \"comment\": \"\"\n }\n ],\n \"requestedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"description\": \"\",\n \"outputSchema\": \"\",\n \"exampleOutput\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"FIRE_AND_FORGET\",\n \"inputSchema\": \"\",\n \"exampleInput\": {\n \"accessRequestId\": \"\",\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"operation\": \"Remove\",\n \"description\": \"\",\n \"comment\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"operation\": \"Remove\",\n \"description\": \"\",\n \"comment\": \"\"\n }\n ],\n \"requestedBy\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"description\": \"\",\n \"outputSchema\": \"\",\n \"exampleOutput\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"IDENTITY\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbb73dee-68d1-46b0-a4e9-e59d1b1f6127", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**id** **name**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "de3c6744-36af-4ec3-b94f-9b15ef5bc509", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**id** **name**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5de2caf3-8d13-44d9-b14e-48ac2c2c7728", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**id** **name**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8fe6c066-bcf5-42ff-afad-0302c082553b", + "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": { + "url": { + "path": [ + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**id** **name**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efe22dfa-ccc2-4fef-aff5-37a0ed53e404", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**id** **name**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "trigger-subscriptions", + "description": "", + "item": [ + { + "id": "d7252b60-7173-4c34-8343-4b22bb9df623", + "name": "Create a Subscription", + "request": { + "name": "Create a Subscription", + "description": { + "content": "This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required:\n* HTTP subscriptions require httpConfig\n* EventBridge subscriptions require eventBridgeConfig", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6b2896d0-41aa-494f-a41d-a9356cd918c5", + "name": "New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"enabled\": true,\n \"responseDeadline\": \"PT1H\",\n \"description\": \"\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"filter\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7de4faa2-e830-4633-8d2f-dba2644acb00", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bc53eb0a-afff-4554-b5c5-7437fd0d06e8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c0cd37c-2dfb-4788-a83c-5ffe1819bc46", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb24613c-91ba-4551-ae5e-0e5f96b6ca5e", + "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": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74692d4b-b9ec-4b57-99a4-421e26e9a455", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a7733a3b-8876-487b-8c53-8ed900ef50ec", + "name": "List Subscriptions", + "request": { + "name": "List Subscriptions", + "description": { + "content": "Gets a list of all trigger subscriptions.", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**triggerId**: *eq*\n\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **triggerName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "75364b11-2165-4198-aabb-9d14bd684030", + "name": "List of subscriptions.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**triggerId**: *eq*\n\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **triggerName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"triggerId\": \"\",\n \"type\": \"SCRIPT\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"enabled\": true,\n \"responseDeadline\": \"PT1H\",\n \"description\": \"\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"filter\": \"\"\n },\n {\n \"id\": \"\",\n \"triggerId\": \"\",\n \"type\": \"INLINE\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"enabled\": true,\n \"responseDeadline\": \"PT1H\",\n \"description\": \"\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"DYNAMIC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"filter\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af1d6ba9-bb45-4fac-822f-b8475181e3a0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**triggerId**: *eq*\n\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **triggerName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "56f79379-dce9-4be4-ab30-c09a4c069645", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**triggerId**: *eq*\n\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **triggerName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b028dfe4-becc-41a4-9b8b-d8c1de0bba7e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**triggerId**: *eq*\n\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **triggerName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38bc7c9c-70cb-47a7-8f66-76b78c701c22", + "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": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**triggerId**: *eq*\n\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **triggerName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01515ef9-8e0e-4371-85b9-bef93e129092", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**triggerId**: *eq*\n\n**type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **triggerName**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "ba987978-3dc0-45b3-b706-171f3e690fb6", + "name": "Update a Subscription", + "request": { + "name": "Update a Subscription", + "description": { + "content": "This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing\n Subscription is completely replaced. The following fields are immutable:\n\n\n * id\n\n * triggerId\n\n\n Attempts to modify these fields result in 400.", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SCRIPT\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a572282f-b202-4cb9-8933-3f10b49a60f9", + "name": "Updated subscription.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SCRIPT\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"enabled\": true,\n \"responseDeadline\": \"PT1H\",\n \"description\": \"\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"filter\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec9948f3-008d-4093-9802-5fde8ab90fc9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SCRIPT\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e96f792d-05c1-4fc7-af45-2d1829dcb080", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SCRIPT\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "664af475-4fce-4aaa-8faf-da4d9c14e7eb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SCRIPT\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3c2c43ba-3bba-496b-befa-d7cc646484e3", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SCRIPT\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a8ce0bbb-9cb8-477a-aea0-94351911131e", + "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": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SCRIPT\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "623d0f37-3d46-4404-9678-f15de6123f14", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SCRIPT\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"enabled\": true,\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "57117a4d-ffed-40ff-83a9-d39045ff0a5c", + "name": "Patch a Subscription", + "request": { + "name": "Patch a Subscription", + "description": { + "content": "This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable:\n\n**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig**", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a10e7d70-b3dd-4f21-ad85-6035de1818fc", + "name": "Updated subscription.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"triggerId\": \"\",\n \"type\": \"WORKFLOW\",\n \"name\": \"\",\n \"triggerName\": \"\",\n \"enabled\": true,\n \"responseDeadline\": \"PT1H\",\n \"description\": \"\",\n \"httpConfig\": {\n \"url\": \"\",\n \"httpDispatchMode\": \"ASYNC\",\n \"httpAuthenticationType\": \"NO_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"\",\n \"password\": \"\"\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": \"\"\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"\",\n \"awsRegion\": \"\"\n },\n \"filter\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "90fd990a-d048-4741-8acf-2d810d581f9c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "253abc5e-e9f5-4ed8-8163-42fcafc85dac", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e29cfb32-2343-40c5-98f3-26790baee1f7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aec10dee-8311-4833-9f9b-e954a2d1a126", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "552b9c4a-fe90-4262-959f-ba34f087d527", + "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": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bca17ade-7904-4cf1-b97c-88a35487eedf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d752a979-7104-48f0-9b3d-da087969506f", + "name": "Delete a Subscription", + "request": { + "name": "Delete a Subscription", + "description": { + "content": "Deletes an existing subscription to a trigger.", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "755daa32-217d-4bd9-971a-ba8134c129d8", + "name": "Subscription is deleted successfully.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "274dacab-8517-4836-aa0c-e9525c8641b6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f8925614-1d9f-4e99-ba60-e3a1cc554ad5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36055506-9949-4521-a235-421329a0d7a2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16eca801-6a2f-43ea-88db-7c460301f907", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26860ec3-fb3e-4f9a-8a4b-18ef5672c8dd", + "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": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cdfd4a76-8e39-44a1-909d-58ea476e8f5c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "validate-filter", + "description": "", + "item": [ + { + "id": "921a12ee-a928-4c13-aade-a5bba95f5f51", + "name": "Validate a Subscription Filter", + "request": { + "name": "Validate a Subscription Filter", + "description": { + "content": "Validates a JSONPath filter expression against a provided mock input.\nRequest requires a security scope of: ", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-subscriptions", + "validate-filter" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {},\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a5e2159d-8d85-4936-b53e-e9823db6edb5", + "name": "Boolean whether specified filter expression is valid against the input.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + "validate-filter" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {},\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"isValid\": false,\n \"isValidJSONPath\": false,\n \"isPathExist\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2d2d748a-2cb7-4c65-a2a2-aba3e4ecf616", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + "validate-filter" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {},\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c67a51c-195b-4c5d-853d-c70e3e4509a4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + "validate-filter" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {},\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b3280243-480f-42bf-af6a-676ddbc24fd0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + "validate-filter" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {},\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b18ae7d1-d394-442b-8167-f347ed613240", + "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": { + "url": { + "path": [ + "trigger-subscriptions", + "validate-filter" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {},\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5523bb6e-bb13-4d57-9a27-6ee18a6a6c7e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-subscriptions", + "validate-filter" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {},\n \"filter\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "trigger-invocations", + "description": "", + "item": [ + { + "name": "status", + "description": "", + "item": [ + { + "id": "0fbdeea3-a5e9-4a69-a798-5dcd962877d5", + "name": "List Latest Invocation Statuses", + "request": { + "name": "List Latest Invocation Statuses", + "description": { + "content": "Gets a list of latest invocation statuses.\nStatuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours.\nThis endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations.", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-invocations", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**triggerId**: *eq* **subscriptionId**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **subscriptionName** **created** **completed**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ebe3e4ac-e83b-444e-8eac-51607417686f", + "name": "List of latest invocation statuses.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**triggerId**: *eq* **subscriptionId**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **subscriptionName** **created** **completed**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"triggerId\": \"\",\n \"subscriptionId\": \"\",\n \"startInvocationInput\": {\n \"triggerId\": \"\",\n \"input\": {},\n \"contentJson\": {}\n },\n \"type\": \"TEST\",\n \"created\": \"\",\n \"completed\": \"\",\n \"completeInvocationInput\": {\n \"localizedError\": {\n \"locale\": \"\",\n \"message\": \"\"\n },\n \"output\": {}\n }\n },\n {\n \"id\": \"\",\n \"triggerId\": \"\",\n \"subscriptionId\": \"\",\n \"startInvocationInput\": {\n \"triggerId\": \"\",\n \"input\": {},\n \"contentJson\": {}\n },\n \"type\": \"REAL_TIME\",\n \"created\": \"\",\n \"completed\": \"\",\n \"completeInvocationInput\": {\n \"localizedError\": {\n \"locale\": \"\",\n \"message\": \"\"\n },\n \"output\": {}\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "56a22c59-1747-4197-a46c-d3f829778de5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**triggerId**: *eq* **subscriptionId**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **subscriptionName** **created** **completed**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a3cfcc25-094a-4f2b-a52c-d730a50ad2a1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**triggerId**: *eq* **subscriptionId**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **subscriptionName** **created** **completed**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b08f59b2-77bd-49a6-8eef-a6e23a1e123e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**triggerId**: *eq* **subscriptionId**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **subscriptionName** **created** **completed**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e154f7d-100b-4670-9f60-54b3c6a4ad32", + "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": { + "url": { + "path": [ + "trigger-invocations", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**triggerId**: *eq* **subscriptionId**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **subscriptionName** **created** **completed**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2bf39a69-b94d-4aac-b192-d45ad865eccf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**triggerId**: *eq* **subscriptionId**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**triggerId** **subscriptionName** **created** **completed**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "name": "complete", + "description": "", + "item": [ + { + "id": "6b7c8c67-148d-40a0-9cd5-133e1262b611", + "name": "Complete Trigger Invocation", + "request": { + "name": "Complete Trigger Invocation", + "description": { + "content": "Completes an invocation to a REQUEST_RESPONSE type trigger.", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-invocations", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"secret\": \"\",\n \"output\": {},\n \"error\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8ea90d72-9349-457e-af49-4d853cf4be89", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"secret\": \"\",\n \"output\": {},\n \"error\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "2293897e-0ddd-4168-a7f7-9d6f6675e511", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"secret\": \"\",\n \"output\": {},\n \"error\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "79754c4d-df74-404b-8e8f-e81ae0ac8f89", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"secret\": \"\",\n \"output\": {},\n \"error\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "913e7f28-b017-49ef-9c6e-bb9cd550597c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"secret\": \"\",\n \"output\": {},\n \"error\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc95e2df-f8d0-4684-965b-beddc70a11ca", + "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": { + "url": { + "path": [ + "trigger-invocations", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"secret\": \"\",\n \"output\": {},\n \"error\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff22a87d-5c45-48a6-a2ba-58f965078b15", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"secret\": \"\",\n \"output\": {},\n \"error\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "test", + "description": "", + "item": [ + { + "id": "6880d8d5-4240-425b-b9f7-3c86051879ae", + "name": "Start a Test Invocation", + "request": { + "name": "Start a Test Invocation", + "description": { + "content": "Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent.", + "type": "text/plain" + }, + "url": { + "path": [ + "trigger-invocations", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"contentJson\": {},\n \"input\": {},\n \"subscriptionIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2b757be6-b491-496a-90df-c65e5c62b264", + "name": "Test trigger invocations that have been started for specified subscription(s).", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"contentJson\": {},\n \"input\": {},\n \"subscriptionIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"triggerId\": \"\",\n \"secret\": \"\",\n \"contentJson\": {}\n },\n {\n \"id\": \"\",\n \"triggerId\": \"\",\n \"secret\": \"\",\n \"contentJson\": {}\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "43947411-0cd6-4b31-8a54-6ce0bb3c1547", + "name": "Trigger invocation is skipped, because tenant has not subscribed to the specified trigger.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"contentJson\": {},\n \"input\": {},\n \"subscriptionIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "f0b303e2-ebb0-4ac4-8cea-5ecb0c8be058", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"contentJson\": {},\n \"input\": {},\n \"subscriptionIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "de931451-fb84-4d6f-a3f9-21ae2db867c6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"contentJson\": {},\n \"input\": {},\n \"subscriptionIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cdd04e19-292b-4977-ae33-0dc80ef29b0b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"contentJson\": {},\n \"input\": {},\n \"subscriptionIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "183102f4-bf0a-4cf8-9455-e24be7f5dbad", + "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": { + "url": { + "path": [ + "trigger-invocations", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"contentJson\": {},\n \"input\": {},\n \"subscriptionIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0d204a0-4d87-4793-8618-a089be0fb91f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "trigger-invocations", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"triggerId\": \"\",\n \"contentJson\": {},\n \"input\": {},\n \"subscriptionIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "verified-from-addresses", + "description": "", + "item": [ + { + "id": "3198fc47-0895-4a62-80c6-c835c454c8b3", + "name": "List From Addresses", + "request": { + "name": "List From Addresses", + "description": { + "content": "Retrieve a list of sender email addresses and their verification statuses", + "type": "text/plain" + }, + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**email**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "16f85b43-9a4d-40c4-b18f-cd17f82ed6a2", + "name": "List of Email Status", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**email**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"FAILED\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"FAILED\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e29baedf-e7fd-452f-a24d-a7e1f79a9959", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**email**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "59290d31-372b-4717-b36b-45c006f662d1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**email**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "52b32fd1-1c08-46cb-8026-bdffdeed7589", + "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": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**email**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cda93d93-015b-407c-9b9d-c59887137fb2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**email**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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:\n\n**email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b33ff839-ac19-40ab-896b-a6cd53ef54e9", + "name": "Create Verified From Address", + "request": { + "name": "Create Verified From Address", + "description": { + "content": "Create a new sender email address and initiate verification process.", + "type": "text/plain" + }, + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"PENDING\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "526cbe11-8da3-4698-8b96-1fd6006325a8", + "name": "New Verified Email Status", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"PENDING\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"PENDING\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d204e89f-b9cc-45e2-9c4c-703559d6780a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"PENDING\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cde99f01-aea2-47fb-9121-fcfd9fb1b049", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"PENDING\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fc54328b-3ead-4ab7-89f3-3e377e57171d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"PENDING\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f01c4092-0c40-48ff-af8d-2cb52639745a", + "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": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"PENDING\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ac7c6f6-c125-4d7c-8f4a-ac40ba636622", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"email\": \"\",\n \"verificationStatus\": \"PENDING\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "78a72f82-06f3-4b09-8662-f288ab6d6733", + "name": "Delete Verified From Address", + "request": { + "name": "Delete Verified From Address", + "description": { + "content": "Delete a verified sender email address", + "type": "text/plain" + }, + "url": { + "path": [ + "verified-from-addresses", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "0bc86dcc-5801-49a5-a720-810a508bc515", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "9f71e08f-9042-4cb4-af46-e2006a5f1928", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "77a55f11-ea10-475a-aa90-779ce00bf87a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "107c552e-3166-4875-b10e-2c8ca3d41619", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2988b391-57f6-43d2-808d-19aadf57548c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4de6cb92-a93b-424a-b96b-6bd6b92ff581", + "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": { + "url": { + "path": [ + "verified-from-addresses", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e47450e0-3cf0-492b-b580-28dbff2fbe83", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "verified-from-addresses", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "verified-domains", + "description": "", + "item": [ + { + "id": "8cb79c1a-d469-42dd-8c62-07a9cd66dd05", + "name": "Get DKIM Attributes", + "request": { + "name": "Get DKIM Attributes", + "description": { + "content": "Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call.", + "type": "text/plain" + }, + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3c6b1b51-82f0-4385-b8f7-cece342c2799", + "name": "List of DKIM Attributes", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"address\": \"\",\n \"dkimEnabled\": false,\n \"dkimTokens\": [\n \"\",\n \"\"\n ],\n \"dkimVerificationStatus\": \"\"\n },\n {\n \"id\": \"\",\n \"address\": \"\",\n \"dkimEnabled\": false,\n \"dkimTokens\": [\n \"\",\n \"\"\n ],\n \"dkimVerificationStatus\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "531d4ca4-050c-4596-991e-8ef3726cbded", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ac68f289-949a-4a25-a56b-afe1677836f8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12948436-e096-475d-b82f-44e1a482f387", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "27f5abe5-f2c4-4d0b-8e5a-88de5158b4d0", + "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": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f8c1ded3-9b25-4629-8497-88ecaeb5cf65", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "91b454f6-31d1-4875-8c19-640b1830cfe4", + "name": "Verify domain address via DKIM", + "request": { + "name": "Verify domain address via DKIM", + "description": { + "content": "Create a domain to be verified via DKIM (DomainKeys Identified Mail)", + "type": "text/plain" + }, + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1fbc7e7a-81f3-4c6d-a7e3-1fac5fdcd63f", + "name": "List of DKIM tokens required for the verification process.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"domain\": \"\",\n \"dkimEnabled\": false,\n \"dkimTokens\": [\n \"\",\n \"\"\n ],\n \"dkimVerificationStatus\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "85c132b7-3df9-4df0-90c5-aacf50fedf9a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a9523094-8644-4931-8744-6176301f899a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13fdfb39-a0a6-43e8-a621-01943eaeb27e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ba02f685-6bac-42ab-a116-deedcd82b25f", + "name": "Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Method Not Allowed", + "code": 405, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"errorName\": {\n \"description\": \"A message describing the error\",\n \"example\": \"NotSupportedException\"\n },\n \"errorMessage\": {\n \"description\": \"Description of the error\",\n \"example\": \"Cannot consume content type\"\n },\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d0de2ff5-bc45-4f5b-aedc-2bf86bfc13b1", + "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": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8173e546-074e-405d-be02-b240b821d6ba", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "verified-domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "sod-policies", + "description": "", + "item": [ + { + "id": "7e3192e5-b671-4dea-addc-81644f700be0", + "name": "Create SOD policy", + "request": { + "name": "Create SOD policy", + "description": { + "content": "This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "14f7c9f8-f454-4365-b2bc-44b91e33f5bf", + "name": "SOD policy created", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cab37ea3-181a-4e46-9a9a-7e3dbf2afdbb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b576e82-9589-4cc8-9ed4-d3cdc82e63ab", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3d396f92-d05e-4143-af2e-c646b7dbe27f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99320b61-28d3-456c-bfd3-12108f7be5dc", + "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": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f75356c-618e-47a6-aa06-715c4131259f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "bc5402ba-b10c-4fac-ae64-aa26509a7ab3", + "name": "List SOD policies", + "request": { + "name": "List SOD policies", + "description": { + "content": "This gets list of all SOD policies.\nRequires role of ORG_ADMIN", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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* **name**: *eq* **state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "654b25fb-d0a0-4eec-99cc-367a3369dc67", + "name": "List of all SOD policies.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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* **name**: *eq* **state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"STATIC\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": null,\n \"ownerRef\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ddb9b73c-43d7-4bd6-9e41-7aadcb658c01", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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* **name**: *eq* **state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24ded625-d8d1-4616-8094-9fdf0e4ac6da", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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* **name**: *eq* **state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1edf354b-980a-4e6f-bc57-6c8849708330", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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* **name**: *eq* **state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4dca74fa-8638-42cb-aac9-39c95c669b6a", + "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": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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* **name**: *eq* **state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24b330c7-adea-495e-b552-ccf77f76956d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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* **name**: *eq* **state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "199396e6-a6d1-40b2-9496-febb0f67503c", + "name": "Get SOD policy by ID", + "request": { + "name": "Get SOD policy by ID", + "description": { + "content": "This gets specified SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d8d7533f-9e04-471e-8fc8-1c09baa44c32", + "name": "SOD policy ID.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e3c4df8-2a89-4f9d-96b2-7a7e7830c14f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51961ae5-e29d-45c5-acef-3040364f5076", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7471d9ec-f557-4a66-aaa7-6474a5b90eff", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c56c0ba8-35a0-4d32-85e0-8003ff928698", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df9c930c-640f-45d9-99a9-cac665c94285", + "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": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "288aa3e0-814a-45b2-9640-ee9615794ab9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "e7132423-ff6e-4839-8f66-c57cb40fda81", + "name": "Update SOD policy by ID", + "request": { + "name": "Update SOD policy by ID", + "description": { + "content": "This updates a specified SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1e8e0bc1-1a4e-4f0d-9599-f6b66f6420ab", + "name": "SOD Policy by ID", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd649f14-16ee-460b-8075-4eb1d5f75be5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f8901378-88cf-4d23-b27b-d0e4633843b4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a64c2456-b629-4faf-9944-23e261dc1f32", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e324f369-b466-4d16-aaaa-3c1ab9276172", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa17ffd1-de5b-46de-9dc3-571edf633a78", + "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": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7823f09a-6b86-4553-9699-80e8418a8133", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d6202455-5262-4b47-8a85-1188cfa0c45f", + "name": "Delete SOD policy by ID", + "request": { + "name": "Delete SOD policy by ID", + "description": { + "content": "This deletes a specified SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "7ed4eacb-9b2b-4af5-a545-d01477a6d913", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "5e29cd4c-ae0a-4ae0-924b-de985937a55b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a883d487-3f8f-44b5-8d7b-8009173da106", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9d78ed44-c4b4-4d41-a365-98983b3a6912", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c9f8a387-f52a-4e90-b5dd-ca038a744b16", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "535bd3b6-58b8-45cc-a4c4-5573e5a7d9b4", + "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": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e033ed37-1e0a-4c66-b323-063024cd6512", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "036befc0-a61d-4d2c-b122-883b65bd6757", + "name": "Patch a SOD policy", + "request": { + "name": "Patch a SOD policy", + "description": { + "content": "Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nRequires role of ORG_ADMIN.\nThis endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. ", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "07b7b582-5264-4c7e-b418-1a7550997d54", + "name": "Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "79cea462-30d8-4f6d-a7af-da5bf2464586", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9890c262-6666-43e1-b289-2287b4ef40df", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "769a4116-3514-42b0-bce4-114331169a1a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ae9c1b3-93db-4ea6-8ce4-86c42969a284", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "071e6c50-9478-4b7c-ac97-7fcbd08da7f3", + "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": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75ecb8a2-ce42-447d-bb2a-5c9089d34d16", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "schedule", + "description": "", + "item": [ + { + "id": "47cdeee4-1357-4f6d-adc4-f5d22f577e27", + "name": "Get SOD policy schedule", + "request": { + "name": "Get SOD policy schedule", + "description": { + "content": "This endpoint gets a specified SOD policy's schedule.\nRequires the role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "af44ffbb-8d41-4f1e-b844-a51dd10a68ae", + "name": "SOD policy ID.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d1ab375-a576-4c14-bc8b-bdfe10c4a935", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a465cf4d-5222-40e5-9ecc-18acba2811db", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c343c890-d7e6-4ca4-b951-e11750075d05", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "baebc154-8989-486d-a7c0-d495e6d43ef2", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecb80be2-03cd-4437-9ca2-01f2093eab56", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b59b54d1-42f7-4f90-b0c9-805f41dd6dfb", + "name": "Update SOD Policy schedule", + "request": { + "name": "Update SOD Policy schedule", + "description": { + "content": "This updates schedule for a specified SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c3925aa1-f6aa-49a7-8512-f7a0227bc64e", + "name": "SOD policy by ID.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26c3671e-d0a9-45e8-872a-c7ad620e183f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "87ca517d-ab99-45bd-be02-e4f019d852dd", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d248ab7-4035-4bae-b149-3ef6e7602929", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "929415c9-82e4-44f3-aa24-6ef3464aeb4c", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63d2c9b3-101a-444e-a2d2-1d7f362bec5d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": \"\",\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b0d6927f-a3ed-45eb-97e1-13757b063186", + "name": "Delete SOD policy schedule", + "request": { + "name": "Delete SOD policy schedule", + "description": { + "content": "This deletes schedule for a specified SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "e54450e9-02fb-4dad-9812-5097e934d16d", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "dfb4f563-5a2f-48bd-b22c-3859645541b8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4432d7e-b234-4e6e-ad4f-b442b8db3536", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efad6b62-f400-40be-b4a0-4406ce2b7ac9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20778a6f-3fc8-4057-ae9c-7a9b229a0905", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63ba2f56-30e4-4077-8d1c-adc9015bfbdc", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8cfc0eb6-ddbb-4a07-8f2d-b8f99986b0a4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "violation-report", + "description": "", + "item": [ + { + "name": "run", + "description": "", + "item": [ + { + "id": "258849d0-f937-4c18-a85f-c4d8fed0ea4a", + "name": "Runs SOD policy violation report", + "request": { + "name": "Runs SOD policy violation report", + "description": { + "content": "This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "ed9145b1-eb5e-4511-b0bb-6b1d44d8f54b", + "name": "Reference to the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"TEMP_ERROR\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "439f3d9c-26cd-47ec-b41b-057f40c0453c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1c0cb3fd-2378-4e5f-b798-18e3c34ca962", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bde0803e-4114-424d-878b-a30b113b1807", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20bddb1e-011a-4101-b627-3219942456cc", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ae2773c-097e-4d76-b2a8-23520abdd03a", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4cbfa192-abc6-4dfb-b7c5-ed1151ed509e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "id": "532915d1-39b1-4c9a-997f-bab334f7e972", + "name": "Get SOD violation report status", + "request": { + "name": "Get SOD violation report status", + "description": { + "content": "This gets the status for a violation report run task that has already been invoked.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "7d34690a-3a0d-4831-9595-263fce9e1779", + "name": "Status of the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"TEMP_ERROR\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e11ede3d-302a-4a94-8e1e-aad180f98cc0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "04d9ae31-aebd-4711-be19-bd0c55ac8262", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "676d0093-5703-4525-990c-f88c8a18964c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "05254872-ced2-4328-bc85-1a72b686a382", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f619532d-68ea-4e5e-ae89-3c3fa9acca63", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4532e37-32f7-4803-b196-ce25d00ab3a0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "sod-violation-report-status", + "description": "", + "item": [ + { + "name": "{reportResultId}", + "description": "", + "item": [ + { + "id": "9fa71091-cc4c-4afa-b34a-3cb2ec28d126", + "name": "Get violation report run status", + "request": { + "name": "Get violation report run status", + "description": { + "content": "This gets the status for a violation report run task that has already been invoked.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "reportResultId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "20235066-f0cd-4e68-a90d-a13c486f081a", + "name": "Status of the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"TEMP_ERROR\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7cdfa929-96cf-4887-b4ab-bfd47979c5b0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db05cb68-746e-4d58-bf86-312cc79b2679", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "41a5c86c-2552-451a-8f4a-1ee2b2d9e821", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea0b9335-7742-44ce-a8b8-bb12c7dbb2f5", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e28ec59-d46b-4c52-9713-59d6d356efcc", + "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": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4e2b11c-16a3-4656-b3c1-aac9f8f9ce37", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "sod-violations", + "description": "", + "item": [ + { + "name": "predict", + "description": "", + "item": [ + { + "id": "da17fa3e-28b9-414b-8c10-3ed57859bf19", + "name": "Predict SOD violations for the given identity if they were granted the given access.", + "request": { + "name": "Predict SOD violations for the given identity if they were granted the given access.", + "description": { + "content": "This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.\n\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c9fe6c25-0eaf-499c-9dc4-c6382d1be698", + "name": "Violation Contexts", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "727a7bbe-ed78-4d00-8e27-2848c253c018", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2dd42578-0bd9-4d5d-bd5e-dbd9b0ad5fe9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "25731f32-f11f-46b0-9efa-e33031ed7a8e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "66abb167-bcd8-4ab1-8406-c766b01a7554", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a71a4b27-14b6-484a-bd4c-515db89d16c1", + "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": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f39bcfdd-a795-40e5-accc-86b073e99077", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "sod-violation-report", + "description": "", + "item": [ + { + "name": "run", + "description": "", + "item": [ + { + "id": "8b508970-9ce4-4d7b-82a8-b621bee3c6d0", + "name": "Runs all policies for org", + "request": { + "name": "Runs all policies for org", + "description": { + "content": "Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f53b43d4-4e05-4753-81f8-6f5d8120b360", + "name": "Reference to the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"TEMP_ERROR\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c9adfae4-beba-4693-817a-aae9f2c977fe", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67d99054-2483-417a-ac05-364982fb60a5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "767e0cf4-58fd-4b1e-ac48-eb03cb168326", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "884d4d4b-cdb8-473d-8991-3fac7693e77c", + "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": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fbf622aa-e0db-4f9e-9ce6-ddfe103be1dd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "id": "5486ca4b-bb33-4e0c-8de7-6aa387b22354", + "name": "Get multi-report run task status", + "request": { + "name": "Get multi-report run task status", + "description": { + "content": "This endpoint gets the status for a violation report for all policy run.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e69fc007-2406-441a-9818-9301e686eb52", + "name": "Status of the violation report run task for all policy run.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"TEMP_ERROR\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "954bfeff-f862-4600-8d39-5cb74553874e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a19b98c0-16df-4fd4-8a09-eccbf09f6027", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fe75a88f-9c8d-4234-8eee-f768c3511b8f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "addca073-1287-407f-bd98-f4d3a35dcaa2", + "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": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c53a8e3d-7373-4cc3-afda-e29d024fcfb7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{reportResultId}", + "description": "", + "item": [ + { + "name": "download", + "description": "", + "item": [ + { + "id": "e1ee4f60-cae7-449c-bb72-a2ac0951fb2e", + "name": "Download violation report", + "request": { + "name": "Download violation report", + "description": { + "content": "This allows to download a violation report for a given report reference.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "reportResultId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "936cbbe1-64b6-47c5-9295-d258afaad7ac", + "name": "Returns the PolicyReport.zip that contains the violation report file.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "f51c7c8d-4dbb-429c-b6bf-02fcf5feba64", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da1a5e62-1807-4e5a-8b2d-b368a2f10696", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ee0b409-e7d5-4754-a2d7-6dc45e233d75", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "653b20ba-04ab-4749-a645-25d4fd000994", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8ba49fe1-1d52-474b-9dcd-ba32aae7c639", + "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": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2fddd7d2-30e3-4a37-870a-01bb2f2b93cc", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{fileName}", + "description": "", + "item": [ + { + "id": "0bd573c0-77c0-4a1a-9063-7675b1722fb9", + "name": "Download custom violation report", + "request": { + "name": "Download custom violation report", + "description": { + "content": "This allows to download a specified named violation report for a given report reference.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "reportResultId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "fileName", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "73d5b7d2-ed37-4ebc-9f33-fe2de66e5758", + "name": "Returns the zip file with given custom name that contains the violation report file.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "80034344-d4b2-4c59-a872-385a771317a0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1f9b1e5d-2427-4191-8b0e-c01c14dc776f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ca0aa86-c79f-412b-837a-75ca89c98b20", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4c62fbc4-0dd2-4167-a59e-a815f4795b01", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3188a75f-a186-44ff-a302-cc7322f116d4", + "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": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ba5a0d1-fc7a-43b7-811d-be22932cb80a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "work-items", + "description": "", + "item": [ + { + "id": "b3ba5a88-159e-4c38-94e9-b4daaa0a05ce", + "name": "List Work Items", + "request": { + "name": "List Work Items", + "description": { + "content": "This gets a collection of work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "68406d98-0f66-4422-816f-795aa6b7e1da", + "name": "List of work items", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"DELEGATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"CHALLENGE\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"EXPIRED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1f2aeb89-21ca-4c83-ad56-49aa47bf6f82", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c17e4794-42f1-494f-bdf9-30ee87d01576", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ddb578a4-9241-4d03-a7e7-8fb555af3ef7", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "completed", + "description": "", + "item": [ + { + "id": "21d3f0ae-aad0-4b71-aaed-9af075fb48aa", + "name": "Completed Work Items", + "request": { + "name": "Completed Work Items", + "description": { + "content": "This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "45c4bdd4-1b13-4287-a044-a340a90a04cd", + "name": "List of completed work items.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"DELEGATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"CHALLENGE\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"EXPIRED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89da1505-c356-4a44-98bc-b86d70851c3c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98384039-eb68-4d40-bb71-02d003cb7f10", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "142ffcac-31b0-4abc-9c82-d5901165c023", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "count", + "description": "", + "item": [ + { + "id": "7ae3cb23-4e46-421d-a1d2-c04e4f670dd0", + "name": "Count Work Items", + "request": { + "name": "Count Work Items", + "description": { + "content": "This gets a count of work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "b8661efe-9158-474b-8766-d59a2688ceff", + "name": "List of work items", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"count\": \"\"\n },\n {\n \"count\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "795fe744-2567-4cbb-85aa-1511a356e472", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "296a3a95-d592-4875-a315-55fddd980ba2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "44c8410c-a5f0-4cf1-a54d-062974f75724", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "completed", + "description": "", + "item": [ + { + "id": "25a1d916-0f32-4f36-9426-39c894d03d54", + "name": "Count Completed Work Items", + "request": { + "name": "Count Completed Work Items", + "description": { + "content": "This gets a count of completed work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "count", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5cdad809-a40f-42d9-bcc3-2df5d5d0ab07", + "name": "List of work items", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"count\": \"\"\n },\n {\n \"count\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb119f11-f551-4f77-b5a8-31612b0ba95e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6bbfe2de-1b4c-4c8d-ab33-4a7f2060f561", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3f1d131d-1d64-48d8-819f-67f362d9cb02", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "summary", + "description": "", + "item": [ + { + "id": "acb35899-306b-4387-a08f-ee69463d6902", + "name": "Work Items Summary", + "request": { + "name": "Work Items Summary", + "description": { + "content": "This gets a summary of work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "43ea3582-9ad0-4413-8abd-566102f419bc", + "name": "List of work items", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"open\": \"\",\n \"completed\": \"\",\n \"total\": \"\"\n },\n {\n \"open\": \"\",\n \"completed\": \"\",\n \"total\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6058e7c-4c59-482b-80d8-2f789a305536", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73a25142-711d-470c-8f14-6df10e6f73ff", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d75f5844-3358-422f-8484-932bdd17ce41", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "a9d65ada-0007-451a-8a5e-48d259b97b94", + "name": "Get a Work Item", + "request": { + "name": "Get a Work Item", + "description": { + "content": "This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8c97741a-f00c-4968-8e77-dd82b708932f", + "name": "The work item with the given ID.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"DELEGATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"REJECTED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"CHALLENGE\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"EXPIRED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96ba79d9-a897-4e1a-b313-b7919507de86", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bd2c2495-1895-46dd-b9b9-c58afbb77c46", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ebc34987-37b8-4bd2-a5af-c04216528ff1", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9448a60a-c6e0-4578-9d33-eee4d8e8361a", + "name": "Complete a Work Item", + "request": { + "name": "Complete a Work Item", + "description": { + "content": "This API completes a work item. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "fe1dcdb7-a396-479e-af21-95e453286965", + "name": "A WorkItems object", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"RETURNED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dbd8ea01-7fcc-4d90-83c4-31d53e53ca9d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5f42479-dd62-42a6-8d35-dbec85d7c9e2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f6f7673f-4d52-4d9d-88d0-97f6d0772e06", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "forward", + "description": "", + "item": [ + { + "id": "23d95c05-90f0-4b42-92c0-7aa975963942", + "name": "Forward a Work Item", + "request": { + "name": "Forward a Work Item", + "description": { + "content": "This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"targetOwnerId\": \"\",\n \"comment\": \"\",\n \"sendNotifications\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e27bc91f-f22d-482c-ae2d-f9c6b464ec67", + "name": "Success, but no data is returned.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"targetOwnerId\": \"\",\n \"comment\": \"\",\n \"sendNotifications\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "3c782b44-3bf4-4475-975c-f4c1471770ad", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"targetOwnerId\": \"\",\n \"comment\": \"\",\n \"sendNotifications\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7f291af7-08b5-485d-b304-58312ea46599", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"targetOwnerId\": \"\",\n \"comment\": \"\",\n \"sendNotifications\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bc735ed-f236-4639-a8ed-848c434b9647", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"targetOwnerId\": \"\",\n \"comment\": \"\",\n \"sendNotifications\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0729badb-ff9c-46af-9efc-42b588e589e3", + "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": { + "url": { + "path": [ + "work-items", + ":id", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"targetOwnerId\": \"\",\n \"comment\": \"\",\n \"sendNotifications\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eae63958-0e0a-4079-bb44-f8f993a4ad3a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"targetOwnerId\": \"\",\n \"comment\": \"\",\n \"sendNotifications\": true\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "approve", + "description": "", + "item": [ + { + "name": "{approvalItemId}", + "description": "", + "item": [ + { + "id": "295ab2f7-f65d-48a1-bac9-8e5550d65bc3", + "name": "Approve an Approval Item", + "request": { + "name": "Approve an Approval Item", + "description": { + "content": "This API approves an Approval Item. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "approvalItemId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "c626edaa-9e0e-4034-b58c-df77900e54d1", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"RETURNED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20bd4e9e-ad9b-46ff-a9c3-f704440f0433", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "53f98f06-07ff-45f2-b67d-eda8d3626042", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a7bbc9f8-7e0d-4c85-884f-edfc2fde7455", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "reject", + "description": "", + "item": [ + { + "name": "{approvalItemId}", + "description": "", + "item": [ + { + "id": "df6779e0-b614-497b-ac2c-30452dffac85", + "name": "Reject an Approval Item", + "request": { + "name": "Reject an Approval Item", + "description": { + "content": "This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "approvalItemId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "c5a8720e-8856-4610-aba9-1b2ebf00fa6a", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"RETURNED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bd609d39-7e37-4dac-b860-50985d730979", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d6162ebe-2983-4639-a3c1-7e2db770e54a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97a3eeff-1696-4344-b085-9916508a8816", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "submit-account-selection", + "description": "", + "item": [ + { + "id": "c89b2935-a991-4afd-b3e0-677b5839058e", + "name": "Submit Account Selections", + "request": { + "name": "Submit Account Selections", + "description": { + "content": "This API submits account selections. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"occaecat_1\": -67844045,\n \"utac\": -2347816.178345144\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "418407f8-fca2-4c6c-a5ad-f957c1d70269", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"occaecat_1\": -67844045,\n \"utac\": -2347816.178345144\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"RETURNED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fac99fba-7981-4f3d-9469-73cef8e61e4b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"occaecat_1\": -67844045,\n \"utac\": -2347816.178345144\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c9b8de8e-ebe6-404c-a352-e20195382be8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"occaecat_1\": -67844045,\n \"utac\": -2347816.178345144\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "37cc1b2e-a0d5-4677-8d8d-29a4a3eb23b2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"occaecat_1\": -67844045,\n \"utac\": -2347816.178345144\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-approve", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "fcbbf9ad-bbe1-49a0-8c60-75eafbabc2d5", + "name": "Bulk approve Approval Items", + "request": { + "name": "Bulk approve Approval Items", + "description": { + "content": "This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "b1cf0dd9-05f0-4b60-9da9-e85831c742f7", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"RETURNED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1096221-4007-41b7-a253-73b94ce26259", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "778926a2-b136-49c9-a902-7eb10d945e78", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "43bb2d30-b2e3-4aa9-8dfa-968e213052e3", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-reject", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "b2c66937-9a41-4ab8-b529-58e32d49f06e", + "name": "Bulk reject Approval Items", + "request": { + "name": "Bulk reject Approval Items", + "description": { + "content": "This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "38917ff9-3cff-42c6-94db-0142a46e5cff", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"CANCELED\",\n \"type\": \"EVENT\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"RETURNED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "010dd45f-6183-443f-804c-2beabe8ae934", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1a375c7-66d7-482c-9b75-10f150865f4b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5a404b38-9c16-45f7-ac56-bfc6a6861d28", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "workflows", + "description": "", + "item": [ + { + "id": "e3d415eb-ba25-484c-9027-8a2b45399f1c", + "name": "Create Workflow", + "request": { + "name": "Create Workflow", + "description": { + "content": "Create a new workflow with the desired trigger and steps specified in the request body.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"laboruma\": -36469153.161327794,\n \"incididunt_6d7\": true\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "df8fc27b-9768-48a9-901d-dfa44b0bc774", + "name": "The Workflow object", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"laboruma\": -36469153.161327794,\n \"incididunt_6d7\": true\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"executionCount\": \"\",\n \"failureCount\": \"\",\n \"created\": \"\",\n \"creator\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"pariaturc05\": \"eiusmod Lorem nulla\",\n \"reprehenderit__\": 53230240\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40a0a65c-ab4f-4c81-aad9-95171473906e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"laboruma\": -36469153.161327794,\n \"incididunt_6d7\": true\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "71b8bb19-eac3-470b-a2de-c648da379fdc", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"laboruma\": -36469153.161327794,\n \"incididunt_6d7\": true\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "61d737f8-99d5-4122-acc5-556241fc17c9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"laboruma\": -36469153.161327794,\n \"incididunt_6d7\": true\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1b5dfbe6-0efe-4cf5-8b0b-d977263f0592", + "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": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"laboruma\": -36469153.161327794,\n \"incididunt_6d7\": true\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65d37d8d-8bce-4355-843a-b1c73aa696bf", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"laboruma\": -36469153.161327794,\n \"incididunt_6d7\": true\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a300f589-c254-4f9b-91a2-7f8890911685", + "name": "List Workflows", + "request": { + "name": "List Workflows", + "description": { + "content": "List all workflows in the tenant.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3848585e-bb2c-47c3-8cdc-aab2811c8dc9", + "name": "List of workflows", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"executionCount\": \"\",\n \"failureCount\": \"\",\n \"created\": \"\",\n \"creator\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"ut_b\": \"sed\",\n \"voluptate_cc\": 51350344,\n \"proident4\": 68422014.71352589\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"executionCount\": \"\",\n \"failureCount\": \"\",\n \"created\": \"\",\n \"creator\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"idfa1\": 83867223.29203686,\n \"cupidatat_1\": -80511352\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"SCHEDULED\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1f03296-d8d6-4927-aef7-bb5b59ad56bc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a17059c9-163a-45b7-ab19-8289a195164f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3a0c31aa-c1a6-4ffc-b31b-6b6db038faff", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a49012b-5d79-4039-989f-ebaa80f92493", + "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": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1b02f250-04ef-4842-9c52-6c42031b0678", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "baefc1e3-d96f-4050-9715-929e35abffbb", + "name": "Get Workflow By Id", + "request": { + "name": "Get Workflow By Id", + "description": { + "content": "Get a single workflow by id.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5651c8e4-a3b8-4407-91b2-f56c8623a580", + "name": "The workflow object", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"executionCount\": \"\",\n \"failureCount\": \"\",\n \"created\": \"\",\n \"creator\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"pariaturc05\": \"eiusmod Lorem nulla\",\n \"reprehenderit__\": 53230240\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d20e65cc-748e-4b50-8eb7-fa7d9fbbcfbe", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e62a46eb-2f92-4653-be12-66c6516ff6ce", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bcc8d44-345c-4e13-8014-d102ae1bfe5d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5e304623-5a54-42ab-970e-7358b7ebb42b", + "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": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4bcb761-1fd4-47ee-9b7f-e7b074e7abe7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "df01148b-2ca8-4b61-8b8e-3ce7b19fa78b", + "name": "Update Workflow", + "request": { + "name": "Update Workflow", + "description": { + "content": "Perform a full update of a workflow. The updated workflow object is returned in the response.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"culpa_1\": false,\n \"ad_e2\": false,\n \"in12\": -65668466.37340018\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "682911e9-0e43-43bc-a01c-4534545ac3f5", + "name": "The Workflow object", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"culpa_1\": false,\n \"ad_e2\": false,\n \"in12\": -65668466.37340018\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"executionCount\": \"\",\n \"failureCount\": \"\",\n \"created\": \"\",\n \"creator\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"pariaturc05\": \"eiusmod Lorem nulla\",\n \"reprehenderit__\": 53230240\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8be6d3c-416e-4092-9940-d5792e2a5ab0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"culpa_1\": false,\n \"ad_e2\": false,\n \"in12\": -65668466.37340018\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ffc4ab1a-abba-4436-aee0-3f69f06a144b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"culpa_1\": false,\n \"ad_e2\": false,\n \"in12\": -65668466.37340018\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0719d45b-7a23-4c4d-b4a9-95e6a684dce9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"culpa_1\": false,\n \"ad_e2\": false,\n \"in12\": -65668466.37340018\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d544f7f3-d425-48b2-9021-bfdedfb7f6bf", + "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": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"culpa_1\": false,\n \"ad_e2\": false,\n \"in12\": -65668466.37340018\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "079af40d-4fc6-44da-9744-7ccace84fe15", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"culpa_1\": false,\n \"ad_e2\": false,\n \"in12\": -65668466.37340018\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2add285f-7b55-42bf-a1b6-692b83756258", + "name": "Patch Workflow", + "request": { + "name": "Patch Workflow", + "description": { + "content": "Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f04443aa-20b1-4890-b30e-7a0f4ab28349", + "name": "The Workflow object", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"executionCount\": \"\",\n \"failureCount\": \"\",\n \"created\": \"\",\n \"creator\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"definition\": {\n \"start\": \"\",\n \"steps\": {\n \"pariaturc05\": \"eiusmod Lorem nulla\",\n \"reprehenderit__\": 53230240\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EXTERNAL\",\n \"attributes\": {\n \"id\": \"\",\n \"filter.$\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "541b11da-921a-4507-9947-76981940e2c8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da7b4195-135d-46b9-9b76-e80678a7494f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b3059908-5d85-4a9f-9b54-f4446520a996", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36e42e67-2509-4d70-87d8-a4db776f8216", + "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": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "622e71fb-8348-466e-b9d7-4aeb575eadd2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "49e9cf3f-41a9-4003-930c-2c4ae977f21c", + "name": "Delete Workflow By Id", + "request": { + "name": "Delete Workflow By Id", + "description": { + "content": "Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "bbf146fe-03af-4888-87e4-80cbd6166849", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "4582b511-c8ba-4fe9-98d4-e3e69bcc7c7a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7bce43e0-079d-40e8-90ae-9e09b371fd0c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "72ed8501-e8ca-4a0f-b2f4-516ea921240b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e7b06fe9-c46c-4ff0-9a22-6c50c4946e70", + "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": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "232e0c5f-154c-44d2-a53c-4e9f7d2bed82", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "test", + "description": "", + "item": [ + { + "id": "dc03d1a7-4428-4acb-b7de-c0b1a1ca01a8", + "name": "Test Workflow By Id", + "request": { + "name": "Test Workflow By Id", + "description": { + "content": "Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow.\nThis endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint.\n**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a41d3b1f-ccd1-4455-80c2-0900e27a8cdc", + "name": "The Workflow object", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflowExecutionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f599fef-dcdc-4cc1-9b00-15706c7dd22d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "244a61e7-91ea-4e3c-a605-fc9c54d2dcd5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "672d7b6c-e2a7-4f58-9c92-61cb402c513a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0b8aace-7286-4fb6-8681-21ae4dfea169", + "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": { + "url": { + "path": [ + "workflows", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f56e671-fc6b-434f-bc7f-7ee49800bf76", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "executions", + "description": "", + "item": [ + { + "id": "839a20bd-4c9a-4521-bbed-e3f01de5e035", + "name": "List Workflow Executions", + "request": { + "name": "List Workflow Executions", + "description": { + "content": "This lists the executions for a given workflow. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: \n1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. \n2. Get your workflow ID from the response. \n3. You can then do either of the following: \n\n - Filter to find relevant workflow executions.\n For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"`\n\n - You can paginate through results with the `offset` parameter. \n For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. \n Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. ", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + ":id", + "executions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4e53507f-4854-4a50-8827-f07088b8d0a3", + "name": "List of workflow executions for the given workflow", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "executions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"workflowId\": \"\",\n \"requestId\": \"\",\n \"startTime\": \"\",\n \"closeTime\": \"\",\n \"status\": \"Running\"\n },\n {\n \"id\": \"\",\n \"workflowId\": \"\",\n \"requestId\": \"\",\n \"startTime\": \"\",\n \"closeTime\": \"\",\n \"status\": \"Failed\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e80f7f25-6058-4cba-bd38-0d3c4a1e7755", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "executions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95e35af7-62bd-46ee-91f1-2b7831c1f882", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "executions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4229d902-c9ab-4230-b5e0-d6712badd9b7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "executions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17da2fdc-64da-4aeb-8ccf-430c82aa6adf", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "executions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "675e3489-f550-47e9-91ee-66eb39550967", + "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": { + "url": { + "path": [ + "workflows", + ":id", + "executions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9f6ba35-baa0-47c1-a91b-353c9b34e04a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "executions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "external", + "description": "", + "item": [ + { + "name": "oauth-clients", + "description": "", + "item": [ + { + "id": "2e32c964-1ff2-41e9-8dae-9a3a4e5f7d13", + "name": "Generate External Trigger OAuth Client", + "request": { + "name": "Generate External Trigger OAuth Client", + "description": { + "content": "Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + ":id", + "external", + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "20c58697-572d-434f-bacd-25cf322a59cd", + "name": "The OAuth Client object", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "external", + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a3253305-fd5a-49b6-a0a9-7215f4d3c39d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "external", + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bff26451-2c3d-4f51-a935-4b9d7567881a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "external", + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6843052c-9508-4bff-b03c-6af56ad27af5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "external", + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a0ccd523-b1ca-4963-8bc8-ec04d1698df2", + "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": { + "url": { + "path": [ + "workflows", + ":id", + "external", + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e700f7a-5f7c-44f1-9f21-1e55e537b9b8", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + ":id", + "external", + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "execute", + "description": "", + "item": [ + { + "name": "external", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "78bc7d85-97a4-449a-bd02-b8ed9dafc9b5", + "name": "Execute Workflow via External Trigger", + "request": { + "name": "Execute Workflow via External Trigger", + "description": { + "content": "This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "eb85dd2d-33c0-4cdf-8f74-9f083a9f1036", + "name": "The Workflow object", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflowExecutionId\": \"\",\n \"message\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0f8462ed-191e-4f86-9147-cb86c3df0580", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20b18157-fe55-49b4-a3d9-1aa2cc8a1b73", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1313e21-3c18-4d2b-9998-0a2cfc71526e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e8a561f-d56d-428e-9735-47be0a51153d", + "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": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ada65efd-ce9e-46f0-a930-13a4c64785df", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "test", + "description": "", + "item": [ + { + "id": "d817a12d-2fa4-4b99-88ed-39ffec1303c6", + "name": "Test Workflow via External Trigger", + "request": { + "name": "Test Workflow via External Trigger", + "description": { + "content": "Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e193088f-a5a8-4c37-aa7b-ee8f7cbce573", + "name": "Responds with the test input", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"payload\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb7a68e7-f5b0-413d-b7a4-7a3df016dce5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98a144b4-7434-4c86-91ff-1e368ac983c0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4ee0e26f-834c-431e-8ba3-1e797e269fab", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b9edd09-3b5a-4503-b20b-bcfc72c2f5b6", + "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": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cbf6facb-c7be-4188-a1b8-9f45e1ac929c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "execute", + "external", + ":id", + "test" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"input\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "workflow-executions", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e046a651-5f18-4cdd-accb-921514f373d3", + "name": "Get a Workflow Execution", + "request": { + "name": "Get a Workflow Execution", + "description": { + "content": "Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow-executions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "180b71f5-bb4d-44e5-a890-e79b6f5b14fd", + "name": "The workflow execution", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"proident deserunt\",\n \"workflowId\": \"adipisicing Duis cillum\",\n \"requestId\": \"sed dolor cillum non\",\n \"startTime\": \"2000-08-22T01:30:02.584Z\",\n \"closeTime\": \"1969-06-28T20:24:33.774Z\",\n \"status\": \"Running\"\n },\n {\n \"id\": \"deserunt enim nisi\",\n \"workflowId\": \"dolore culpa reprehender\",\n \"requestId\": \"ipsum voluptate irure\",\n \"startTime\": \"1964-08-15T10:07:29.458Z\",\n \"closeTime\": \"1989-02-02T20:04:06.014Z\",\n \"status\": \"Completed\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f6fea40-9690-44b0-acae-d71841c06f06", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5dca836-a59f-4809-83c3-a0226a2a8580", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "53358894-f362-4b5d-893e-c7d7c9a8821c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0744d869-abec-473b-9605-a096230e25b4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "576004b6-5259-4d55-8df3-921059e8fc96", + "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": { + "url": { + "path": [ + "workflow-executions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "982760ed-6a45-4fe6-aa7e-598112edbc51", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "history", + "description": "", + "item": [ + { + "id": "b79ab5eb-7e00-43da-a64e-3d6b12b7167b", + "name": "Get Workflow Execution History", + "request": { + "name": "Get Workflow Execution History", + "description": { + "content": "Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow-executions", + ":id", + "history" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f7a2b291-e8bc-491b-9f3d-699d32fc03ec", + "name": "List of workflow execution events for the given workflow execution", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "history" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"type\": \"WorkflowExecutionScheduled\",\n \"timestamp\": \"\",\n \"attributes\": {}\n },\n {\n \"type\": \"ActivityTaskScheduled\",\n \"timestamp\": \"\",\n \"attributes\": {}\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a61fab3-1a37-455c-9392-0d3cd3e2024f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "history" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e80174ca-ce05-4bb7-8ff1-ae3f5077bc3f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "history" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2bd37aa-be61-49ad-8a59-bae62e254577", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "history" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4a0c036-ce1d-4ce8-a29f-7c090a93ae0a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "history" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff0617b2-e20b-40af-9dac-ca6efda64e0d", + "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": { + "url": { + "path": [ + "workflow-executions", + ":id", + "history" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4b34ab3-563e-47a9-93ec-77872a448a56", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "history" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "cancel", + "description": "", + "item": [ + { + "id": "4a1f683b-8980-4907-8bff-d49701f04ca8", + "name": "Cancel Workflow Execution by ID", + "request": { + "name": "Cancel Workflow Execution by ID", + "description": { + "content": "Use this API to cancel a running workflow execution.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow-executions", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "27dfbfeb-53b8-4679-9d32-ec814e1ce47e", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "a69406b4-1511-4e64-946f-444e4f5e6a58", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc6febee-b33b-4b99-9b19-14352ac4d025", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dee6371f-30b5-43a8-8169-ed3a50cf0ec2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "068842ad-6e20-4e7d-b9df-04cfd13c6a50", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a78459f3-3f55-4065-a214-c36672668171", + "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": { + "url": { + "path": [ + "workflow-executions", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed97a845-98ff-44b4-adf0-63a23bb20d4d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflow-executions", + ":id", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "workflow-library", + "description": "", + "item": [ + { + "id": "08114c7f-0403-497c-a071-b3f7fc2f8c7f", + "name": "List Complete Workflow Library", + "request": { + "name": "List Complete Workflow Library", + "description": { + "content": "This lists all triggers, actions, and operators in the library", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow-library" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "42a26a85-0d44-4738-b04d-5187b2f283a5", + "name": "List of workflow steps", + "originalRequest": { + "url": { + "path": [ + "workflow-library" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"formFields\": [\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"json\"\n },\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"secret\"\n }\n ],\n \"isDynamicSchema\": \"\",\n \"outputSchema\": {}\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"formFields\": [\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"array\"\n },\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"checkbox\"\n }\n ],\n \"isDynamicSchema\": \"\",\n \"outputSchema\": {}\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f050e9c8-3365-4c51-aeb6-6a2c9f8a2077", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflow-library" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1721c7a0-4636-4120-8424-66f7690cf151", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflow-library" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef109448-9de4-4c1b-85dd-a3776d3b7049", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflow-library" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7a9c9328-ab2e-450e-a1f0-a567a08185c9", + "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": { + "url": { + "path": [ + "workflow-library" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df2a198d-b4a4-4e83-88fe-8c6c5c24971a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflow-library" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "actions", + "description": "", + "item": [ + { + "id": "1798924e-874f-4004-b357-cb85c8ed6ca5", + "name": "List Workflow Library Actions", + "request": { + "name": "List Workflow Library Actions", + "description": { + "content": "This lists the workflow actions available to you.", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow-library", + "actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "0e825907-4b8f-4d50-b46f-271c1d46f761", + "name": "List of workflow actions", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"formFields\": [\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"json\"\n },\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"secret\"\n }\n ],\n \"isDynamicSchema\": \"\",\n \"outputSchema\": {}\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"formFields\": [\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"array\"\n },\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"checkbox\"\n }\n ],\n \"isDynamicSchema\": \"\",\n \"outputSchema\": {}\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "335173ae-b2f9-4b60-be4e-a3ff0fd4f685", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a7c3486c-f915-4929-97c3-b7b17e1bcf92", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6e0605ff-d227-41d9-b39c-b2414037be42", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3d5a8b51-14c4-4014-98b4-12b10a3fd29f", + "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": { + "url": { + "path": [ + "workflow-library", + "actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3637008f-7c20-4863-bfb4-6ea18c4f4249", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "triggers", + "description": "", + "item": [ + { + "id": "fb8a629b-16cf-48e4-b8b9-27a5682c7d94", + "name": "List Workflow Library Triggers", + "request": { + "name": "List Workflow Library Triggers", + "description": { + "content": "This lists the workflow triggers available to you", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow-library", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8b3c621f-defc-4b41-9670-1d66ef667f9f", + "name": "List of workflow triggers", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"type\": \"EVENT\",\n \"name\": \"\",\n \"description\": \"\",\n \"isDynamicSchema\": \"\",\n \"inputExample\": {},\n \"formFields\": [\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"url\"\n },\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"identityPicker\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"type\": \"EXTERNAL\",\n \"name\": \"\",\n \"description\": \"\",\n \"isDynamicSchema\": \"\",\n \"inputExample\": {},\n \"formFields\": [\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"array\"\n },\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"checkbox\"\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f1723e8a-2573-456d-b447-a21cf7320de0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c9f3f8a6-6b67-4118-a401-e31d05a1aadd", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0dbf29b3-ba94-45b6-85f8-205918b049ee", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e64a311-7e37-41ee-bf2c-f1bc20e2cc9a", + "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": { + "url": { + "path": [ + "workflow-library", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e3c0c083-d0e9-4aba-af1a-e4f0946efd47", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "triggers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "operators", + "description": "", + "item": [ + { + "id": "85e75871-a048-419e-8818-55610d66c368", + "name": "List Workflow Library Operators", + "request": { + "name": "List Workflow Library Operators", + "description": { + "content": "This lists the workflow operators available to you", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow-library", + "operators" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "7c7ed517-cdfd-41cc-a31c-8571b14beb02", + "name": "List of workflow operators", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "operators" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"formFields\": [\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"secret\"\n },\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"number\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"formFields\": [\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"object\"\n },\n {\n \"helpText\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"required\": \"\",\n \"type\": \"array\"\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f749564-6c96-43ad-a8bf-c56891b1433d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "operators" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67c9614c-6a63-4b5b-ac83-65b2c9bbe45a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "operators" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c9c443f-ada4-4e2e-bfe1-8d1f2aaab934", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "operators" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6d3ede16-1b78-4cf7-aeb0-1604cfd499fb", + "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": { + "url": { + "path": [ + "workflow-library", + "operators" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e8790ccf-5ae3-4d80-9df9-993d33451606", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workflow-library", + "operators" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "workgroups", + "description": "", + "item": [ + { + "id": "381afaf5-2017-4f85-a510-7cf6c17ffc64", + "name": "List Governance Groups", + "request": { + "name": "List Governance Groups", + "description": { + "content": "This API returns list of Governance Groups", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "47813a1e-4c59-453c-8534-a2244974f727", + "name": "List of Governance Groups", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"owner\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n },\n {\n \"owner\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75f0c483-36cd-47d2-9651-bee07be04079", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a8aa262-9589-4180-aea0-62d960c62582", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "465bd3cd-1749-414d-b459-5a20ae916b02", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2109ea6-1123-4b71-a541-868b1e47580c", + "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": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1389ed19-b1bb-4670-8df5-873d359ef783", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "e352cc2b-a755-458e-af10-2e92bbfa7ed3", + "name": "Create a new Governance Group.", + "request": { + "name": "Create a new Governance Group.", + "description": { + "content": "This API creates a new Governance Group.", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a174a066-e0ed-4c76-a622-e20369af00b4", + "name": "Governance Group object created.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c56e69ff-9971-43e5-a9de-52f45252d4c4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "758f2006-920d-4997-b6fb-7a5b4b2aab73", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1191544-394d-459d-ac89-bbbfb8398ce4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8ad8870-641f-4b76-8cd5-2cca8621f331", + "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": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc857c27-3b71-430c-9ce4-270d55939acd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "6bd47809-ff08-4239-98cf-d18a43979fb7", + "name": "Get an Governance Groups", + "request": { + "name": "Get an Governance Groups", + "description": { + "content": "This API returns an Governance Groups by its ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "c1002974-35ae-4a91-80ea-9a02caa48748", + "name": "An Governance Groups", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"memberCount\": \"\",\n \"connectionCount\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c09f17d-25e9-4cf8-ba38-191877c12a95", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d49fabe-1bbf-4907-9038-d0921bbafa92", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89e7ba24-96b5-4992-af74-4e355e5b8647", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9d8275c1-e739-42a8-9c58-7f9a4172d2f0", + "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": { + "url": { + "path": [ + "workgroups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5885b5f7-7380-4e6e-a2b8-cb7919025942", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "form-definitions", + "description": "", + "item": [ + { + "id": "31f79703-fe9b-4b61-ba1a-c6866849b9f7", + "name": "Export form definitions by tenant.", + "request": { + "name": "Export form definitions by tenant.", + "description": { + "content": "No parameters required.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3c3020fd-9f5c-4772-9b41-e70ab13c71c9", + "name": "Returns a list of form definitions by tenant", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"count\": \"\",\n \"results\": [\n {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"ine1f\": {},\n \"exercitation_18\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n },\n {\n \"config\": {\n \"adipisicing_d\": {},\n \"cupidatat_d4\": {}\n },\n \"effectType\": \"ENABLE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"Duis_6\": {},\n \"culpa_e0\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"ipsum558\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n },\n {\n \"operator\": \"EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_83\": {},\n \"cupidatat5e\": {}\n },\n \"elementType\": \"SELECT\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"nostrud_60c\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"deserunt1aa\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"ea_681\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"laboris_8f\": {},\n \"occaecat_47\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"qui44b\": {},\n \"ut5\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"eiusmod_5\": {},\n \"in_04c\": {}\n },\n \"elementType\": \"SECTION\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"elit_be\": {},\n \"sunt33e\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3b4424db-d136-4bd8-855c-617b686d8ef9", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3cba6e69-3754-42de-9377-0dd3724be4a0", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c2208974-0946-4af7-8ff4-744b93a05c0a", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ba20934d-d2c7-47e9-9d5d-58ff22f0c10e", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4df321ac-4115-4602-afc5-bca1f71c11c1", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "362efbac-9d03-4ed6-9ce7-4da09d63b700", + "name": "Creates a form definition.", + "request": { + "name": "Creates a form definition.", + "description": {}, + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"sint4de\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n },\n {\n \"config\": {\n \"et_d\": {},\n \"minim465\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NE\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"dolore_6d\": {},\n \"adipisicingb5\": {},\n \"ullamco_1\": {}\n },\n \"effectType\": \"HIDE\"\n },\n {\n \"config\": {\n \"magna__\": {},\n \"dolor5\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"dolored5d\": {},\n \"ipsum6c\": {},\n \"in_4\": {},\n \"nostrud7a\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"Ut_656\": {},\n \"nonde\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1e7aba7a-9112-41b5-859e-6281959bb78a", + "name": "Returns a new form definition", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"sint4de\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n },\n {\n \"config\": {\n \"et_d\": {},\n \"minim465\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NE\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"dolore_6d\": {},\n \"adipisicingb5\": {},\n \"ullamco_1\": {}\n },\n \"effectType\": \"HIDE\"\n },\n {\n \"config\": {\n \"magna__\": {},\n \"dolor5\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"dolored5d\": {},\n \"ipsum6c\": {},\n \"in_4\": {},\n \"nostrud7a\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"Ut_656\": {},\n \"nonde\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"officiae\": {}\n },\n \"effectType\": \"REQUIRE\"\n },\n {\n \"config\": {\n \"quis4bd\": {},\n \"tempor_eea\": {}\n },\n \"effectType\": \"DISABLE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"eiusmod78_\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"in848\": {},\n \"velit10\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"elit23c\": {},\n \"Loremeb\": {},\n \"culpa45\": {},\n \"nulla_b5\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"voluptate_20\": {},\n \"voluptate_f\": {},\n \"non_135\": {},\n \"aliquipa\": {},\n \"reprehenderit_8be\": {}\n },\n \"elementType\": \"TEXTAREA\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2acb1c3b-20f1-43f6-b5cf-c29a4382a87d", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"sint4de\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n },\n {\n \"config\": {\n \"et_d\": {},\n \"minim465\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NE\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"dolore_6d\": {},\n \"adipisicingb5\": {},\n \"ullamco_1\": {}\n },\n \"effectType\": \"HIDE\"\n },\n {\n \"config\": {\n \"magna__\": {},\n \"dolor5\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"dolored5d\": {},\n \"ipsum6c\": {},\n \"in_4\": {},\n \"nostrud7a\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"Ut_656\": {},\n \"nonde\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "887c6fc2-20ac-41e2-a236-1e640a6a7f99", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"sint4de\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n },\n {\n \"config\": {\n \"et_d\": {},\n \"minim465\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NE\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"dolore_6d\": {},\n \"adipisicingb5\": {},\n \"ullamco_1\": {}\n },\n \"effectType\": \"HIDE\"\n },\n {\n \"config\": {\n \"magna__\": {},\n \"dolor5\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"dolored5d\": {},\n \"ipsum6c\": {},\n \"in_4\": {},\n \"nostrud7a\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"Ut_656\": {},\n \"nonde\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e620341-e00d-460a-88ce-169d371903a3", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"sint4de\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n },\n {\n \"config\": {\n \"et_d\": {},\n \"minim465\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NE\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"dolore_6d\": {},\n \"adipisicingb5\": {},\n \"ullamco_1\": {}\n },\n \"effectType\": \"HIDE\"\n },\n {\n \"config\": {\n \"magna__\": {},\n \"dolor5\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"dolored5d\": {},\n \"ipsum6c\": {},\n \"in_4\": {},\n \"nostrud7a\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"Ut_656\": {},\n \"nonde\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c863d036-bbd5-40a5-97eb-d66129eebc95", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"sint4de\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n },\n {\n \"config\": {\n \"et_d\": {},\n \"minim465\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NE\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"dolore_6d\": {},\n \"adipisicingb5\": {},\n \"ullamco_1\": {}\n },\n \"effectType\": \"HIDE\"\n },\n {\n \"config\": {\n \"magna__\": {},\n \"dolor5\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"dolored5d\": {},\n \"ipsum6c\": {},\n \"in_4\": {},\n \"nostrud7a\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"Ut_656\": {},\n \"nonde\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b84e4e22-dda3-4e63-aab4-29dc4306b702", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"sint4de\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n },\n {\n \"config\": {\n \"et_d\": {},\n \"minim465\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NE\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"dolore_6d\": {},\n \"adipisicingb5\": {},\n \"ullamco_1\": {}\n },\n \"effectType\": \"HIDE\"\n },\n {\n \"config\": {\n \"magna__\": {},\n \"dolor5\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"dolored5d\": {},\n \"ipsum6c\": {},\n \"in_4\": {},\n \"nostrud7a\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"Ut_656\": {},\n \"nonde\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{formDefinitionID}", + "description": "", + "item": [ + { + "id": "17c5ea81-0f36-49cf-b4fb-0ecc5e364004", + "name": "Return a form definition.", + "request": { + "name": "Return a form definition.", + "description": { + "content": "Parameter `{formDefinitionID}` should match a form definition ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "formDefinitionID", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "aad50841-1f05-4fec-8789-bcaf13d07c5a", + "name": "Returns a form definition", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"officiae\": {}\n },\n \"effectType\": \"REQUIRE\"\n },\n {\n \"config\": {\n \"quis4bd\": {},\n \"tempor_eea\": {}\n },\n \"effectType\": \"DISABLE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"eiusmod78_\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"in848\": {},\n \"velit10\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"elit23c\": {},\n \"Loremeb\": {},\n \"culpa45\": {},\n \"nulla_b5\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"voluptate_20\": {},\n \"voluptate_f\": {},\n \"non_135\": {},\n \"aliquipa\": {},\n \"reprehenderit_8be\": {}\n },\n \"elementType\": \"TEXTAREA\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b0a9ab0-c90b-4ebd-a715-ed0433cc72f1", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1f5ebe73-5c00-4e81-8e60-fc8e479f62f4", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b39b19f-d234-4583-accd-04e7328338b5", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63de3660-0a51-4224-8689-d72f0e5e35e8", + "name": "An error with the item not found", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fcd9a479-a899-4e9e-b86b-387bc70e1142", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c1453c7-e615-419d-b3b4-e5bfabfe0c78", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0b1f635a-439c-472c-85b2-e90d91fa7c3a", + "name": "Deletes a form definition.", + "request": { + "name": "Deletes a form definition.", + "description": { + "content": "Parameter `{formDefinitionID}` should match a form definition ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "formDefinitionID", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "296c9632-9a08-49b2-a2a2-0ac9941cbea6", + "name": "Returns an empty body", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a286cdd-c7b3-482d-ad86-e1d955a0b589", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0d47a4d0-c26b-4a89-82f7-d4e4e0ad2a34", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec2b2d9c-6e80-4d94-8ad4-b524ba7db8b9", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "07974b09-7da1-4c03-a267-33eb0e4c6fa6", + "name": "An error with the item not found", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65edca7e-fd4f-4dc1-8dd4-bdc55a0ac585", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9660534f-b118-4203-8597-4dc0ef3759f1", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "7c0d6530-8587-4601-b48e-b91e6311f473", + "name": "Patch a form definition.", + "request": { + "name": "Patch a form definition.", + "description": { + "content": "Parameter `{formDefinitionID}` should match a form definition ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "formDefinitionID", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3fab0d60-3f2a-43a8-bd95-f37b87a2b98a", + "name": "Returns the form definition updated", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"officiae\": {}\n },\n \"effectType\": \"REQUIRE\"\n },\n {\n \"config\": {\n \"quis4bd\": {},\n \"tempor_eea\": {}\n },\n \"effectType\": \"DISABLE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"eiusmod78_\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"in848\": {},\n \"velit10\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"elit23c\": {},\n \"Loremeb\": {},\n \"culpa45\": {},\n \"nulla_b5\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"voluptate_20\": {},\n \"voluptate_f\": {},\n \"non_135\": {},\n \"aliquipa\": {},\n \"reprehenderit_8be\": {}\n },\n \"elementType\": \"TEXTAREA\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "41a2442b-f4ec-4c64-8ea3-03f43b5feecb", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd4a28ea-a22a-44a8-8780-9bb680eb73a1", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "18b283a4-30f0-4d7c-9476-7b7f5c0ef359", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "879fd167-826e-4e61-9261-c89a6f229581", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b8898ac-1281-4313-9624-96da2d765c38", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb2ed98f-4a5e-4e1b-bbcb-b6424a09a640", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "data-source", + "description": "", + "item": [ + { + "id": "e3be5caf-dc79-4980-8cbf-9d10603a92b7", + "name": "Preview form definition data source.", + "request": { + "name": "Preview form definition data source.", + "description": {}, + "url": { + "path": [ + "form-definitions", + ":formDefinitionID", + "data-source" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Query\n\nString specifying to query against", + "type": "text/plain" + }, + "key": "query", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "formDefinitionID", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"dataSource\": {\n \"config\": {\n \"aggregationBucketField\": \"\",\n \"indices\": [\n \"identities\",\n \"*\"\n ],\n \"objectType\": \"ROLE\",\n \"query\": \"\"\n },\n \"dataSourceType\": \"INTERNAL\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "54294ddb-8ad1-4f22-b2e8-e5f90050bbc0", + "name": "Returns a preview of a form definition data source", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID", + "data-source" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Query\n\nString specifying to query against", + "type": "text/plain" + }, + "key": "query", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"dataSource\": {\n \"config\": {\n \"aggregationBucketField\": \"\",\n \"indices\": [\n \"identities\",\n \"*\"\n ],\n \"objectType\": \"ROLE\",\n \"query\": \"\"\n },\n \"dataSourceType\": \"INTERNAL\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"results\": [\n {\n \"label\": \"\",\n \"subLabel\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"subLabel\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f6a1abd2-fa42-4a1b-b928-0506de9f576e", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID", + "data-source" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Query\n\nString specifying to query against", + "type": "text/plain" + }, + "key": "query", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"dataSource\": {\n \"config\": {\n \"aggregationBucketField\": \"\",\n \"indices\": [\n \"identities\",\n \"*\"\n ],\n \"objectType\": \"ROLE\",\n \"query\": \"\"\n },\n \"dataSourceType\": \"INTERNAL\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ee53094-b45c-4230-874f-cd08f800eb0a", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID", + "data-source" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Query\n\nString specifying to query against", + "type": "text/plain" + }, + "key": "query", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"dataSource\": {\n \"config\": {\n \"aggregationBucketField\": \"\",\n \"indices\": [\n \"identities\",\n \"*\"\n ],\n \"objectType\": \"ROLE\",\n \"query\": \"\"\n },\n \"dataSourceType\": \"INTERNAL\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d64d9680-62c2-4963-8fb8-7fa9d603c934", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID", + "data-source" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Query\n\nString specifying to query against", + "type": "text/plain" + }, + "key": "query", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"dataSource\": {\n \"config\": {\n \"aggregationBucketField\": \"\",\n \"indices\": [\n \"identities\",\n \"*\"\n ],\n \"objectType\": \"ROLE\",\n \"query\": \"\"\n },\n \"dataSourceType\": \"INTERNAL\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4d3fb37-6b75-4dd2-b10b-1c34736e39f4", + "name": "An error with the item not found", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID", + "data-source" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Query\n\nString specifying to query against", + "type": "text/plain" + }, + "key": "query", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"dataSource\": {\n \"config\": {\n \"aggregationBucketField\": \"\",\n \"indices\": [\n \"identities\",\n \"*\"\n ],\n \"objectType\": \"ROLE\",\n \"query\": \"\"\n },\n \"dataSourceType\": \"INTERNAL\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab8bc1db-eb5f-4a85-8761-856c784c6f4c", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID", + "data-source" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Query\n\nString specifying to query against", + "type": "text/plain" + }, + "key": "query", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"dataSource\": {\n \"config\": {\n \"aggregationBucketField\": \"\",\n \"indices\": [\n \"identities\",\n \"*\"\n ],\n \"objectType\": \"ROLE\",\n \"query\": \"\"\n },\n \"dataSourceType\": \"INTERNAL\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6309dc5-6bb5-4dbe-acb6-069a7b170a53", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + ":formDefinitionID", + "data-source" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Query\n\nString specifying to query against", + "type": "text/plain" + }, + "key": "query", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"dataSource\": {\n \"config\": {\n \"aggregationBucketField\": \"\",\n \"indices\": [\n \"identities\",\n \"*\"\n ],\n \"objectType\": \"ROLE\",\n \"query\": \"\"\n },\n \"dataSourceType\": \"INTERNAL\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "export", + "description": "", + "item": [ + { + "id": "e922a9d4-901a-4d5e-ae2b-6a26fcf4f3f4", + "name": "List form definitions by tenant.", + "request": { + "name": "List form definitions by tenant.", + "description": { + "content": "No parameters required.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-definitions", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f5aa5cca-f870-44a2-a2cc-9b0978f5a8e6", + "name": "Returns a list of form definition objects by tenant used by SP-Config", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"minim3\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"magna10\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ut_7c_\": {},\n \"proident_00\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"magna82e\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"proident665\": {},\n \"commodo3_7\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"incididunt_63\": {},\n \"ine\": {},\n \"estf\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"anim_6f1\": {},\n \"dolore_6\": {},\n \"adipisicing_7c\": {},\n \"dolor_9\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"adipisicing_309\": {},\n \"ex_10\": {},\n \"dolor_d0\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ad6\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"est_dc\": {},\n \"labore_d\": {},\n \"esseaa\": {},\n \"ametb\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_3d\": {},\n \"culpa3\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"labore_6_8\": {},\n \"laborum71\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26c558ad-f29c-4824-9bd1-3d760095ea3d", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6928e4a-c2ef-4749-8138-9e075218080d", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "03b4f8d2-4b1e-48b9-ada5-3e2b7d3405fb", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4146805a-146a-407b-8076-2ad01082c189", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c792e1a-49bb-4d2d-a46e-af8df802e4e8", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. 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:\nname\ndescription\ncreated\nmodified", + "type": "text/plain" + }, + "key": "sorters", + "value": "name" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "forms-action-dynamic-schema", + "description": "", + "item": [ + { + "id": "33f2cf71-3852-4f29-8310-b172a084c891", + "name": "Generate JSON Schema dynamically.", + "request": { + "name": "Generate JSON Schema dynamically.", + "description": {}, + "url": { + "path": [ + "form-definitions", + "forms-action-dynamic-schema" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"formDefinitionId\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"versionNumber\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "87ddb516-24fd-4e28-b0c1-0648c036d728", + "name": "Returns a form elements dynamic schema", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "forms-action-dynamic-schema" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"formDefinitionId\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"versionNumber\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"outputSchema\": {\n \"dolore_50\": {}\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51be8bc4-4083-4569-bee8-3a6dc14d8976", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "forms-action-dynamic-schema" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"formDefinitionId\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"versionNumber\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a46d05b5-2f41-4dd0-9f90-d7ce1db1eb80", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "forms-action-dynamic-schema" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"formDefinitionId\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"versionNumber\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30534557-107a-43c3-b36c-8e538316799c", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "forms-action-dynamic-schema" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"formDefinitionId\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"versionNumber\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0279c4dd-b6c5-410d-83c5-19ae709fad86", + "name": "An error with the item not found", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "forms-action-dynamic-schema" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"formDefinitionId\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"versionNumber\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "afdd34a3-d836-4142-bd74-1a283f732bfc", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "forms-action-dynamic-schema" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"formDefinitionId\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"versionNumber\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4113493-2380-41ff-a85f-48f9d12d81ea", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "forms-action-dynamic-schema" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"formDefinitionId\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"versionNumber\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "import", + "description": "", + "item": [ + { + "id": "3d80124d-4be0-40eb-8c73-4cd7cbff06c6", + "name": "Import form definitions from export.", + "request": { + "name": "Import form definitions from export.", + "description": {}, + "url": { + "path": [ + "form-definitions", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"minim3\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"magna10\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ut_7c_\": {},\n \"proident_00\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"magna82e\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"proident665\": {},\n \"commodo3_7\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"incididunt_63\": {},\n \"ine\": {},\n \"estf\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"anim_6f1\": {},\n \"dolore_6\": {},\n \"adipisicing_7c\": {},\n \"dolor_9\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"adipisicing_309\": {},\n \"ex_10\": {},\n \"dolor_d0\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ad6\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"est_dc\": {},\n \"labore_d\": {},\n \"esseaa\": {},\n \"ametb\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_3d\": {},\n \"culpa3\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"labore_6_8\": {},\n \"laborum71\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "94bc8efd-94a1-4119-b73f-4ec63281e709", + "name": "Returns statuses of those form definition objects imported", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"minim3\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"magna10\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ut_7c_\": {},\n \"proident_00\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"magna82e\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"proident665\": {},\n \"commodo3_7\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"incididunt_63\": {},\n \"ine\": {},\n \"estf\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"anim_6f1\": {},\n \"dolore_6\": {},\n \"adipisicing_7c\": {},\n \"dolor_9\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"adipisicing_309\": {},\n \"ex_10\": {},\n \"dolor_d0\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ad6\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"est_dc\": {},\n \"labore_d\": {},\n \"esseaa\": {},\n \"ametb\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_3d\": {},\n \"culpa3\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"labore_6_8\": {},\n \"laborum71\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"errors\": [\n {\n \"detail\": {\n \"dolore_f\": {}\n },\n \"key\": \"\",\n \"text\": \"\"\n },\n {\n \"detail\": {\n \"eu_88\": {},\n \"deserunt_1a\": {},\n \"enim0a\": {}\n },\n \"key\": \"\",\n \"text\": \"\"\n }\n ],\n \"importedObjects\": [\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"exercitationa\": {},\n \"infe4\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"sed_b\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"eu_26\": {}\n },\n \"effectType\": \"HIDE\"\n },\n {\n \"config\": {\n \"dolor0f\": {},\n \"dolore7a7\": {},\n \"voluptate_3\": {}\n },\n \"effectType\": \"DISABLE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n },\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"ipsum4\": {},\n \"dolor_\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"anim_f8b\": {},\n \"cupidatat_2\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"sed_8ce\": {},\n \"ex_f46\": {},\n \"exercitation3\": {},\n \"Ute4e\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"tempor_a92\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n },\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"veniam6\": {},\n \"adipisicing383\": {}\n },\n \"effectType\": \"REQUIRE\"\n },\n {\n \"config\": {\n \"aute_b\": {},\n \"in_3a2\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"cupidatat_2\": {},\n \"velit_2fa\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"ipsum__35\": {},\n \"reprehenderit_10\": {}\n },\n \"elementType\": \"HIDDEN\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n ],\n \"infos\": [\n {\n \"detail\": {\n \"eu_73\": {}\n },\n \"key\": \"\",\n \"text\": \"\"\n },\n {\n \"detail\": {\n \"enim3e4\": {}\n },\n \"key\": \"\",\n \"text\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"detail\": {\n \"culpa_6f\": {},\n \"cilluma\": {}\n },\n \"key\": \"\",\n \"text\": \"\"\n },\n {\n \"detail\": {\n \"dolore671\": {},\n \"aliquip_e\": {},\n \"incididunt492\": {}\n },\n \"key\": \"\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5f6eaba-8ce5-42f1-bae8-76a26c4585ae", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"minim3\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"magna10\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ut_7c_\": {},\n \"proident_00\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"magna82e\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"proident665\": {},\n \"commodo3_7\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"incididunt_63\": {},\n \"ine\": {},\n \"estf\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"anim_6f1\": {},\n \"dolore_6\": {},\n \"adipisicing_7c\": {},\n \"dolor_9\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"adipisicing_309\": {},\n \"ex_10\": {},\n \"dolor_d0\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ad6\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"est_dc\": {},\n \"labore_d\": {},\n \"esseaa\": {},\n \"ametb\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_3d\": {},\n \"culpa3\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"labore_6_8\": {},\n \"laborum71\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "022c69ca-7bed-443f-9e70-252fcedc1dc1", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"minim3\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"magna10\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ut_7c_\": {},\n \"proident_00\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"magna82e\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"proident665\": {},\n \"commodo3_7\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"incididunt_63\": {},\n \"ine\": {},\n \"estf\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"anim_6f1\": {},\n \"dolore_6\": {},\n \"adipisicing_7c\": {},\n \"dolor_9\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"adipisicing_309\": {},\n \"ex_10\": {},\n \"dolor_d0\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ad6\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"est_dc\": {},\n \"labore_d\": {},\n \"esseaa\": {},\n \"ametb\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_3d\": {},\n \"culpa3\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"labore_6_8\": {},\n \"laborum71\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1271b915-a988-4b49-aa80-9996659349a6", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"minim3\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"magna10\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ut_7c_\": {},\n \"proident_00\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"magna82e\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"proident665\": {},\n \"commodo3_7\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"incididunt_63\": {},\n \"ine\": {},\n \"estf\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"anim_6f1\": {},\n \"dolore_6\": {},\n \"adipisicing_7c\": {},\n \"dolor_9\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"adipisicing_309\": {},\n \"ex_10\": {},\n \"dolor_d0\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ad6\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"est_dc\": {},\n \"labore_d\": {},\n \"esseaa\": {},\n \"ametb\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_3d\": {},\n \"culpa3\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"labore_6_8\": {},\n \"laborum71\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1e8a4d5-08ec-4c3f-a4dc-4c4776270e7d", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"minim3\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"magna10\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ut_7c_\": {},\n \"proident_00\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"magna82e\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"proident665\": {},\n \"commodo3_7\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"incididunt_63\": {},\n \"ine\": {},\n \"estf\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"anim_6f1\": {},\n \"dolore_6\": {},\n \"adipisicing_7c\": {},\n \"dolor_9\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"adipisicing_309\": {},\n \"ex_10\": {},\n \"dolor_d0\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ad6\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"est_dc\": {},\n \"labore_d\": {},\n \"esseaa\": {},\n \"ametb\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_3d\": {},\n \"culpa3\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"labore_6_8\": {},\n \"laborum71\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8b830f6-cfc6-4e45-9ea5-c90e1ddb3e21", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"minim3\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"magna10\": {}\n },\n \"effectType\": \"SHOW\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ut_7c_\": {},\n \"proident_00\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"magna82e\": {}\n },\n \"effectType\": \"REQUIRE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"proident665\": {},\n \"commodo3_7\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"incididunt_63\": {},\n \"ine\": {},\n \"estf\": {}\n },\n \"elementType\": \"DATE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n },\n {\n \"id\": \"\",\n \"type\": \"WORKFLOW\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n },\n {\n \"object\": {\n \"created\": \"\",\n \"description\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"anim_6f1\": {},\n \"dolore_6\": {},\n \"adipisicing_7c\": {},\n \"dolor_9\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"adipisicing_309\": {},\n \"ex_10\": {},\n \"dolor_d0\": {}\n },\n \"effectType\": \"HIDE\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"ad6\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"est_dc\": {},\n \"labore_d\": {},\n \"esseaa\": {},\n \"ametb\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NOT_CO\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formElements\": [\n {\n \"config\": {\n \"id_3d\": {},\n \"culpa3\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"labore_6_8\": {},\n \"laborum71\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formInput\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"STRING\"\n }\n ],\n \"id\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"usedBy\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n }\n ]\n },\n \"self\": \"\",\n \"version\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "predefined-select-options", + "description": "", + "item": [ + { + "id": "9ce9c172-393b-4458-ae7d-f60ad0cb2ed6", + "name": "List predefined select options.", + "request": { + "name": "List predefined select options.", + "description": { + "content": "No parameters required.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-definitions", + "predefined-select-options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "278a7578-d53b-4216-97cf-4bc594b13c5f", + "name": "Returns a list of available predefined select options", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "predefined-select-options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"results\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "29047c81-545c-466c-9e75-02ae61243c60", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "predefined-select-options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "297daca8-5b61-4db5-9a85-fd1e423f4d8d", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "predefined-select-options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31e03950-5fa3-4f0f-95dc-09e418dd98b6", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "predefined-select-options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "76b82a65-0380-4bcf-af7e-8bf6692cb53a", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "predefined-select-options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e5abdbb-8f49-40ba-ab1b-37f5b899a7b1", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-definitions", + "predefined-select-options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "form-instances", + "description": "", + "item": [ + { + "id": "fc76ce3b-1c30-48a6-b297-933c29837a1c", + "name": "List form instances by tenant.", + "request": { + "name": "List form instances by tenant.", + "description": { + "content": "No parameters required.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f5adc0b0-f194-49a8-b142-791880ec1054", + "name": "Returns a list of form instances by tenant", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"count\": \"\",\n \"results\": [\n {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"WORKFLOW_EXECUTION\"\n },\n \"expire\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"aliquaab3\": {},\n \"id_5af\": {},\n \"officia_c\": {},\n \"mollit1\": {}\n },\n \"effectType\": \"OPTIONAL\"\n },\n {\n \"config\": {\n \"in_e4\": {},\n \"consequat_54\": {},\n \"amet29\": {},\n \"est_a_7\": {},\n \"cillum6f6\": {}\n },\n \"effectType\": \"ENABLE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"EM\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"Excepteur3\": {}\n },\n \"effectType\": \"SHOW\"\n },\n {\n \"config\": {\n \"Duis_f\": {},\n \"id_a78\": {},\n \"sint_ed\": {}\n },\n \"effectType\": \"SET_DEFAULT_VALUE\"\n }\n ],\n \"ruleOperator\": \"OR\",\n \"rules\": [\n {\n \"operator\": \"IN\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"BOOLEAN\"\n },\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n }\n ]\n }\n ],\n \"formData\": {\n \"incididunt8\": {}\n },\n \"formDefinitionId\": \"\",\n \"formElements\": [\n {\n \"config\": {\n \"sit_6\": {},\n \"ut_9\": {},\n \"Ut_c3\": {},\n \"dolore_3a\": {}\n },\n \"elementType\": \"TEXT\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"dolore3\": {},\n \"non_6d\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formErrors\": [\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n },\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n }\n ],\n \"formInput\": {\n \"aute_66\": {},\n \"culpa_c6\": {},\n \"esse_a19\": {}\n },\n \"id\": \"\",\n \"modified\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"standAloneForm\": false,\n \"standAloneFormUrl\": \"\",\n \"state\": \"ASSIGNED\"\n },\n {\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"WORKFLOW_EXECUTION\"\n },\n \"expire\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"reprehenderit_8a\": {},\n \"est_90\": {},\n \"dolor_4\": {},\n \"irure_0c\": {}\n },\n \"effectType\": \"DISABLE\"\n },\n {\n \"config\": {\n \"exebd\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_EM\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n },\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"in_7\": {},\n \"in3a\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"officia_a\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"EQ\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n },\n {\n \"operator\": \"NE\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING\"\n }\n ]\n }\n ],\n \"formData\": {\n \"adipisicing_9\": {},\n \"exercitation_01f\": {}\n },\n \"formDefinitionId\": \"\",\n \"formElements\": [\n {\n \"config\": {\n \"Duis8\": {},\n \"occaecatfce\": {}\n },\n \"elementType\": \"COLUMNS\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"minim_d\": {}\n },\n \"elementType\": \"PHONE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formErrors\": [\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n },\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n }\n ],\n \"formInput\": {\n \"dolore1\": {},\n \"dolor9\": {}\n },\n \"id\": \"\",\n \"modified\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"standAloneForm\": false,\n \"standAloneFormUrl\": \"\",\n \"state\": \"IN_PROGRESS\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c6c86bde-d0be-4475-a601-6dd41ddc3331", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12fa5f46-1c15-41ea-bc83-e7d8149d0164", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1a067b9-dbd0-4bcd-84ef-8a4c05ed742f", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d24fdaba-172a-4c96-b45d-084c31096a4d", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa4446d3-ee7c-4202-a619-393296f9f2e1", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "bd09433b-5b44-44bc-a667-6a6e6c0985b2", + "name": "Creates a form instance.", + "request": { + "name": "Creates a form instance.", + "description": {}, + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"expire\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n \"formDefinitionId\": \"\",\n \"formInput\": {\n \"esse66\": {}\n },\n \"standAloneForm\": false,\n \"state\": \"COMPLETED\",\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "518c56b3-72f0-4215-b060-8a62094743dc", + "name": "Returns a new form instance", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"expire\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n \"formDefinitionId\": \"\",\n \"formInput\": {\n \"esse66\": {}\n },\n \"standAloneForm\": false,\n \"state\": \"COMPLETED\",\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"WORKFLOW_EXECUTION\"\n },\n \"expire\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"voluptate3a\": {},\n \"sit6de\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n },\n {\n \"config\": {\n \"reprehenderit_2\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"sint_4\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"consequat_e\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formData\": {\n \"adipisicing0ee\": {},\n \"magna_5c9\": {}\n },\n \"formDefinitionId\": \"\",\n \"formElements\": [\n {\n \"config\": {\n \"occaecat_70\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"commodo6\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formErrors\": [\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n },\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n }\n ],\n \"formInput\": {\n \"do_fd2\": {}\n },\n \"id\": \"\",\n \"modified\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"standAloneForm\": false,\n \"standAloneFormUrl\": \"\",\n \"state\": \"SUBMITTED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "960c256a-b580-417b-a239-4ea4f83e4773", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"expire\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n \"formDefinitionId\": \"\",\n \"formInput\": {\n \"esse66\": {}\n },\n \"standAloneForm\": false,\n \"state\": \"COMPLETED\",\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1fbb3cb0-8622-4b9f-99c0-00b135a01b36", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"expire\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n \"formDefinitionId\": \"\",\n \"formInput\": {\n \"esse66\": {}\n },\n \"standAloneForm\": false,\n \"state\": \"COMPLETED\",\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a66ca2ef-9edc-415c-aba3-bb927d076ceb", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"expire\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n \"formDefinitionId\": \"\",\n \"formInput\": {\n \"esse66\": {}\n },\n \"standAloneForm\": false,\n \"state\": \"COMPLETED\",\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fe0be065-aea8-4d4b-8566-169c47d95c86", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"expire\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n \"formDefinitionId\": \"\",\n \"formInput\": {\n \"esse66\": {}\n },\n \"standAloneForm\": false,\n \"state\": \"COMPLETED\",\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "52e7ce89-930e-4e9f-884e-07076dedd029", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"expire\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"SOURCE\"\n },\n \"formDefinitionId\": \"\",\n \"formInput\": {\n \"esse66\": {}\n },\n \"standAloneForm\": false,\n \"state\": \"COMPLETED\",\n \"ttl\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{formInstanceID}", + "description": "", + "item": [ + { + "id": "f9ccc70a-35be-43a2-ba7a-07f364dff1d6", + "name": "Returns a form instance.", + "request": { + "name": "Returns a form instance.", + "description": { + "content": "Parameter `{formInstanceID}` should match a form instance ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "formInstanceID", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "60cee141-ec52-465d-896b-6ed8dcae772d", + "name": "Returns a form instance by its key", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"WORKFLOW_EXECUTION\"\n },\n \"expire\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"voluptate3a\": {},\n \"sit6de\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n },\n {\n \"config\": {\n \"reprehenderit_2\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"sint_4\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"consequat_e\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formData\": {\n \"adipisicing0ee\": {},\n \"magna_5c9\": {}\n },\n \"formDefinitionId\": \"\",\n \"formElements\": [\n {\n \"config\": {\n \"occaecat_70\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"commodo6\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formErrors\": [\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n },\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n }\n ],\n \"formInput\": {\n \"do_fd2\": {}\n },\n \"id\": \"\",\n \"modified\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"standAloneForm\": false,\n \"standAloneFormUrl\": \"\",\n \"state\": \"SUBMITTED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "707a29bc-c31a-4474-8d3e-2be00439fa09", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "991e0f2f-5597-482f-a968-2a1e2c1dd88d", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf6b2520-aff8-4f99-83f6-a50260ea071b", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b836219-0cb1-4448-a50e-78cc5dfc44da", + "name": "An error with the item not found", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4593f4e0-d5b4-484e-a039-9cacd651e34e", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7ab2541a-27b9-4a64-849b-519a85cd1b6b", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "080a94df-fef9-4b60-b348-9ecd5a425023", + "name": "Patch a form instance.", + "request": { + "name": "Patch a form instance.", + "description": { + "content": "Parameter `{formInstanceID}` should match a form instance ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "formInstanceID", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "02cb6843-ce20-43eb-b3b3-62a21952f7ae", + "name": "Returns the form instance updated", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"type\": \"WORKFLOW_EXECUTION\"\n },\n \"expire\": \"\",\n \"formConditions\": [\n {\n \"effects\": [\n {\n \"config\": {\n \"voluptate3a\": {},\n \"sit6de\": {}\n },\n \"effectType\": \"SUBMIT_MESSAGE\"\n },\n {\n \"config\": {\n \"reprehenderit_2\": {}\n },\n \"effectType\": \"OPTIONAL\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_EW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"ELEMENT\"\n },\n {\n \"operator\": \"SW\",\n \"source\": \"\",\n \"sourceType\": \"ELEMENT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"INPUT\"\n }\n ]\n },\n {\n \"effects\": [\n {\n \"config\": {\n \"sint_4\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n },\n {\n \"config\": {\n \"consequat_e\": {}\n },\n \"effectType\": \"SUBMIT_NOTIFICATION\"\n }\n ],\n \"ruleOperator\": \"AND\",\n \"rules\": [\n {\n \"operator\": \"NOT_IN\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"STRING_LIST\"\n },\n {\n \"operator\": \"CO\",\n \"source\": \"\",\n \"sourceType\": \"INPUT\",\n \"value\": {\n \"description\": \"Value is the value based on the ValueType\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n },\n \"valueType\": \"LIST\"\n }\n ]\n }\n ],\n \"formData\": {\n \"adipisicing0ee\": {},\n \"magna_5c9\": {}\n },\n \"formDefinitionId\": \"\",\n \"formElements\": [\n {\n \"config\": {\n \"occaecat_70\": {}\n },\n \"elementType\": \"TOGGLE\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n },\n {\n \"config\": {\n \"commodo6\": {}\n },\n \"elementType\": \"EMAIL\",\n \"id\": \"\",\n \"key\": \"\",\n \"validations\": {}\n }\n ],\n \"formErrors\": [\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n },\n {\n \"key\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"Value is the value associated with a Key\",\n \"example\": \"Engineering\",\n \"x-go-name\": \"Value\"\n }\n }\n ],\n \"formInput\": {\n \"do_fd2\": {}\n },\n \"id\": \"\",\n \"modified\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n }\n ],\n \"standAloneForm\": false,\n \"standAloneFormUrl\": \"\",\n \"state\": \"SUBMITTED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4df6b0b1-c997-4e7e-a3f9-842595775638", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d610310-11cf-4505-bd3e-0f9b513cf331", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20c3be6a-4fa3-46cc-9f7b-52c422d2d4a8", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8ed543f4-6eea-46e7-990c-7a22107943af", + "name": "An error with the item not found", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2225d32-1851-4191-b4ba-de70c3df6937", + "name": "An error with the request property conflicts with stored", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Conflict", + "code": 409, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16ffaed5-a65d-42f9-9952-321a83032fc7", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2040675a-f41e-410c-ac94-05b07c3380aa", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"aliquip356\": {}\n },\n {\n \"autef0\": {}\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "data-source", + "description": "", + "item": [ + { + "name": "{formElementID}", + "description": "", + "item": [ + { + "id": "7eb42588-a058-4e9b-b662-cd0d41ee4520", + "name": "Retrieves dynamic data by element.", + "request": { + "name": "Retrieves dynamic data by element.", + "description": { + "content": "Parameter `{formInstanceID}` should match a form instance ID.\nParameter `{formElementID}` should match a form element ID at the data source configuration.", + "type": "text/plain" + }, + "url": { + "path": [ + "form-instances", + ":formInstanceID", + "data-source", + ":formElementID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "formInstanceID", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "formElementID", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "abe23631-ae9a-4c70-8364-b279fa0d0222", + "name": "Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID", + "data-source", + ":formElementID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"results\": [\n {\n \"label\": \"\",\n \"subLabel\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"subLabel\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6193d577-3b3c-408a-a428-5b4d37b60832", + "name": "An error with the request occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID", + "data-source", + ":formElementID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "696777a7-c905-4677-9b10-0eb7a860f2e5", + "name": "An error with the authorization occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID", + "data-source", + ":formElementID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af00e43c-7020-4dcd-841e-a6a3a4f17f26", + "name": "An error with the user permissions occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID", + "data-source", + ":formElementID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73f6b533-c895-40e7-ba37-a0904df95128", + "name": "An error with the item not found", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID", + "data-source", + ":formElementID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5dd2fb9-4c20-4264-9fdb-6bcdb9db3722", + "name": "Too many requests", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID", + "data-source", + ":formElementID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c8f015f1-45de-4d0d-8f73-3fcbba93d79c", + "name": "An internal server error occurred", + "originalRequest": { + "url": { + "path": [ + "form-instances", + ":formInstanceID", + "data-source", + ":formElementID" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Filters\n\nFilter 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:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"\",\n \"text\": \"\"\n }\n ],\n \"statusCode\": \"\",\n \"trackingId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "const domain = pm.environment.get('domain') ? pm.environment.get('domain') : pm.collectionVariables.get('domain')", + "const tokenUrl = 'https://' + pm.environment.get('tenant') + '.api.' + domain + '.com/oauth/token';", + "const clientId = pm.environment.get('clientId');", + "const clientSecret = pm.environment.get('clientSecret');", + "", + "const getTokenRequest = {", + " method: 'POST',", + " url: tokenUrl,", + " body: {", + " mode: 'formdata',", + " formdata: [{", + " key: 'grant_type',", + " value: 'client_credentials'", + " },", + " {", + " key: 'client_id',", + " value: clientId", + " },", + " {", + " key: 'client_secret',", + " value: clientSecret", + " }", + " ]", + " }", + "};", + "", + "", + "var moment = require('moment');", + "if (!pm.environment.has('tokenExpTime')) {", + " pm.environment.set('tokenExpTime', moment());", + "}", + "", + "if (moment(pm.environment.get('tokenExpTime')) <= moment() || !pm.environment.get('tokenExpTime') || !pm.environment.get('accessToken')) {", + " var time = moment();", + " time.add(12, 'hours');", + " pm.environment.set('tokenExpTime', time);", + " pm.sendRequest(getTokenRequest, (err, response) => {", + " const jsonResponse = response.json();", + " if (response.code != 200) {", + " throw new Error(`Unable to authenticate: ${JSON.stringify(jsonResponse)}`);", + " }", + " const newAccessToken = jsonResponse.access_token;", + " pm.environment.set('accessToken', newAccessToken);", + " });", + "", + "}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "key": "domain", + "value": "identitynow", + "type": "string" + }, + { + "key": "baseUrl", + "value": "https://{{tenant}}.api.{{domain}}.com", + "type": "string" + } + ], + "info": { + "_postman_id": "b4621eef-2870-4df4-93ab-8427a23c5828", + "name": "IdentityNow Beta API", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. 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", + "type": "text/plain" + } + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{accessToken}}", + "type": "string" + } + ] + } +} \ No newline at end of file diff --git a/postman/collections/sailpoint-api-cc.json b/postman/collections/sailpoint-api-cc.json new file mode 100644 index 0000000..a1ac576 --- /dev/null +++ b/postman/collections/sailpoint-api-cc.json @@ -0,0 +1,2176 @@ +{ + "item": [ + { + "name": "cc", + "description": "", + "item": [ + { + "name": "api", + "description": "", + "item": [ + { + "name": "account", + "description": "", + "item": [ + { + "name": "list", + "description": "", + "item": [ + { + "id": "2be84caa-474a-4a80-91d4-9377536efed4", + "name": "List Accounts", + "request": { + "name": "List Accounts", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "account", + "list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "74db08c1-5ac8-46b9-88c9-fdc9e5168616", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "account", + "list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "remove", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "350ad9c1-2df5-4898-b4e9-9e2902cf8075", + "name": "Remove Account", + "request": { + "name": "Remove Account", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "account", + "remove", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "5927f6ba-99a8-4d9b-b419-a92d9167e254", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "account", + "remove", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "app", + "description": "", + "item": [ + { + "name": "list", + "description": "", + "item": [ + { + "id": "87a46cf7-7671-49d7-994e-41752d1b4db5", + "name": "List Applications", + "request": { + "name": "List Applications", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "app", + "list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3e7c1c02-a0d5-49bd-8e0c-ca27362ededb", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "app", + "list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"appId\": \"\",\n \"serviceId\": \"\",\n \"serviceAppId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appCenterEnabled\": \"\",\n \"provisionRequestEnabled\": \"\",\n \"controlType\": \"\",\n \"mobile\": \"\",\n \"privateApp\": \"\",\n \"scriptName\": \"\",\n \"status\": \"\",\n \"icon\": \"\",\n \"health\": {\n \"status\": \"\",\n \"lastChanged\": \"\",\n \"since\": \"\",\n \"healthy\": \"\"\n },\n \"enableSso\": \"\",\n \"ssoMethod\": \"\",\n \"hasLinks\": \"\",\n \"hasAutomations\": \"\",\n \"stepUpAuthData\": {},\n \"stepUpAuthType\": \"\",\n \"usageAnalytics\": \"\",\n \"usageCertRequired\": \"\",\n \"usageCertText\": {},\n \"launchpadEnabled\": \"\",\n \"passwordManaged\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"defaultAccessProfile\": {},\n \"service\": \"\",\n \"selectedSsoMethod\": \"\",\n \"supportedSsoMethods\": \"\",\n \"offNetworkBlockedRoles\": {},\n \"supportedOffNetwork\": \"\",\n \"accountServiceId\": \"\",\n \"launcherCount\": \"\",\n \"accountServiceName\": \"\",\n \"accountServiceExternalId\": \"\",\n \"accountServiceMatchAllAccounts\": \"\",\n \"externalId\": \"\",\n \"accountServiceUseForPasswordManagement\": \"\",\n \"accountServicePolicyId\": \"\",\n \"accountServicePolicyName\": \"\",\n \"requireStrongAuthn\": \"\",\n \"accountServicePolicies\": [\n {\n \"policyId\": \"\",\n \"policyName\": \"\",\n \"selectors\": {}\n },\n {\n \"policyId\": \"\",\n \"policyName\": \"\",\n \"selectors\": {}\n }\n ],\n \"xsdVersion\": \"\",\n \"appProfiles\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"createdBy\": \"\",\n \"dateCreated\": \"\",\n \"xsdVersion\": \"\"\n },\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"createdBy\": \"\",\n \"dateCreated\": \"\",\n \"xsdVersion\": \"\"\n }\n ],\n \"passwordServiceId\": \"\",\n \"accessProfileIds\": {}\n },\n {\n \"id\": \"\",\n \"appId\": \"\",\n \"serviceId\": \"\",\n \"serviceAppId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appCenterEnabled\": \"\",\n \"provisionRequestEnabled\": \"\",\n \"controlType\": \"\",\n \"mobile\": \"\",\n \"privateApp\": \"\",\n \"scriptName\": \"\",\n \"status\": \"\",\n \"icon\": \"\",\n \"health\": {\n \"status\": \"\",\n \"lastChanged\": \"\",\n \"since\": \"\",\n \"healthy\": \"\"\n },\n \"enableSso\": \"\",\n \"ssoMethod\": \"\",\n \"hasLinks\": \"\",\n \"hasAutomations\": \"\",\n \"stepUpAuthData\": {},\n \"stepUpAuthType\": \"\",\n \"usageAnalytics\": \"\",\n \"usageCertRequired\": \"\",\n \"usageCertText\": {},\n \"launchpadEnabled\": \"\",\n \"passwordManaged\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"defaultAccessProfile\": {},\n \"service\": \"\",\n \"selectedSsoMethod\": \"\",\n \"supportedSsoMethods\": \"\",\n \"offNetworkBlockedRoles\": {},\n \"supportedOffNetwork\": \"\",\n \"accountServiceId\": \"\",\n \"launcherCount\": \"\",\n \"accountServiceName\": \"\",\n \"accountServiceExternalId\": \"\",\n \"accountServiceMatchAllAccounts\": \"\",\n \"externalId\": \"\",\n \"accountServiceUseForPasswordManagement\": \"\",\n \"accountServicePolicyId\": \"\",\n \"accountServicePolicyName\": \"\",\n \"requireStrongAuthn\": \"\",\n \"accountServicePolicies\": [\n {\n \"policyId\": \"\",\n \"policyName\": \"\",\n \"selectors\": {}\n },\n {\n \"policyId\": \"\",\n \"policyName\": \"\",\n \"selectors\": {}\n }\n ],\n \"xsdVersion\": \"\",\n \"appProfiles\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"createdBy\": \"\",\n \"dateCreated\": \"\",\n \"xsdVersion\": \"\"\n },\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"createdBy\": \"\",\n \"dateCreated\": \"\",\n \"xsdVersion\": \"\"\n }\n ],\n \"passwordServiceId\": \"\",\n \"accessProfileIds\": {}\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "get", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "ce2ec7dd-f4bd-4013-a073-d3ec199b7b19", + "name": "Get Single Application", + "request": { + "name": "Get Single Application", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "app", + "get", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "44e32055-8597-4475-aaec-b4d8c9adff1b", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "app", + "get", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"appId\": \"\",\n \"serviceId\": \"\",\n \"serviceAppId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"appCenterEnabled\": \"\",\n \"provisionRequestEnabled\": \"\",\n \"controlType\": \"\",\n \"mobile\": \"\",\n \"privateApp\": \"\",\n \"scriptName\": \"\",\n \"status\": \"\",\n \"icon\": \"\",\n \"health\": {\n \"status\": \"\",\n \"lastChanged\": \"\",\n \"since\": \"\",\n \"healthy\": \"\"\n },\n \"enableSso\": \"\",\n \"ssoMethod\": \"\",\n \"hasLinks\": \"\",\n \"hasAutomations\": \"\",\n \"stepUpAuthData\": {},\n \"stepUpAuthType\": \"\",\n \"usageAnalytics\": \"\",\n \"usageCertRequired\": \"\",\n \"usageCertText\": {},\n \"launchpadEnabled\": \"\",\n \"passwordManaged\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"defaultAccessProfile\": {},\n \"service\": \"\",\n \"selectedSsoMethod\": \"\",\n \"supportedSsoMethods\": \"\",\n \"offNetworkBlockedRoles\": {},\n \"supportedOffNetwork\": \"\",\n \"accountServiceId\": \"\",\n \"launcherCount\": \"\",\n \"accountServiceName\": \"\",\n \"accountServiceExternalId\": \"\",\n \"accountServiceMatchAllAccounts\": \"\",\n \"externalId\": \"\",\n \"accountServiceUseForPasswordManagement\": \"\",\n \"accountServicePolicyId\": \"\",\n \"accountServicePolicyName\": \"\",\n \"requireStrongAuthn\": \"\",\n \"accountServicePolicies\": [\n {\n \"policyId\": \"\",\n \"policyName\": \"\",\n \"selectors\": {}\n },\n {\n \"policyId\": \"\",\n \"policyName\": \"\",\n \"selectors\": {}\n }\n ],\n \"xsdVersion\": \"\",\n \"appProfiles\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"createdBy\": \"\",\n \"dateCreated\": \"\",\n \"xsdVersion\": \"\"\n },\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"createdBy\": \"\",\n \"dateCreated\": \"\",\n \"xsdVersion\": \"\"\n }\n ],\n \"passwordServiceId\": \"\",\n \"accessProfileIds\": {}\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "getAccessProfiles", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "0954c76c-8013-4cc4-8da8-cc15483f47e1", + "name": "Get Access Profiles for Application", + "request": { + "name": "Get Access Profiles for Application", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "app", + "getAccessProfiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "fffa74dc-356f-46f1-a19e-3a0174d55738", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "app", + "getAccessProfiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "create", + "description": "", + "item": [ + { + "id": "a011ffd4-a480-4b1d-9de4-a9d056216aae", + "name": "Create Application", + "request": { + "name": "Create Application", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "app", + "create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "37fe87b1-a1b7-48b7-950f-e4af86135db3", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "app", + "create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "update", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "4978f65b-14ea-416b-8cbe-7732139afd14", + "name": "Update Application", + "request": { + "name": "Update Application", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "app", + "update", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "582d5c0d-9420-40a4-b6df-88b766cf5b83", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "app", + "update", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "delete", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "81472860-9224-49b8-83f2-df1b9622b9be", + "name": "Delete Application", + "request": { + "name": "Delete Application", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "app", + "delete", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "fb7084ba-a09a-406a-8bf1-6e918a2d98d7", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "app", + "delete", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "connector", + "description": "", + "item": [ + { + "name": "list", + "description": "", + "item": [ + { + "id": "a3ef0fc9-f9fd-4f1b-9df2-a1110c15b54a", + "name": "List Connectors", + "request": { + "name": "List Connectors", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "connector", + "list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "da24226a-fe54-4e60-a7e1-71145670c4f8", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "connector", + "list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "create", + "description": "", + "item": [ + { + "id": "9dc71642-acdd-4900-9757-c271b5535be8", + "name": "Create Connector", + "request": { + "name": "Create Connector", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "connector", + "create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/x-www-form-urlencoded" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "description", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "className", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "directConnect", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "status", + "value": "" + } + ] + } + }, + "response": [ + { + "id": "fb2aa711-0d09-4be5-856b-bff485dd3f9a", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "connector", + "create" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/x-www-form-urlencoded" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "description", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "className", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "directConnect", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "", + "type": "text/plain" + }, + "key": "status", + "value": "" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "delete", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "35dcf201-2b51-427f-be25-d2da8514f18d", + "name": "Delete Connector", + "request": { + "name": "Delete Connector", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "connector", + "delete", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "2978eff8-60ea-4009-8a84-5ce88f1e434e", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "connector", + "delete", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "export", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e72ba254-376b-4f69-b341-6f69b5744ef3", + "name": "Export Connector Config", + "request": { + "name": "Export Connector Config", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "connector", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "0954660f-be0d-4b4d-ad85-1f863cfc629d", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "connector", + "export", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "import", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "1d8ee045-3995-44f4-b89d-52d0ff8bb52a", + "name": "Import Connector Config", + "request": { + "name": "Import Connector Config", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "connector", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "This is the connector config zip bundle which gets uploaded.", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "98661576-c053-4b0d-84ac-d0b74e6d2723", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "connector", + "import", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "This is the connector config zip bundle which gets uploaded.", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "user", + "description": "", + "item": [ + { + "name": "updatePermissions", + "description": "", + "item": [ + { + "id": "8e9edbfe-db9e-45f5-b88c-6706171996c0", + "name": "Update User Permissions", + "request": { + "name": "Update User Permissions", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "user", + "updatePermissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": \"\",\n \"isAdmin\": \"\",\n \"adminType\": \"ROLE_SUBADMIN\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c1c89ab0-78ae-4b40-bfcb-5cd1d5553286", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "user", + "updatePermissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": \"\",\n \"isAdmin\": \"\",\n \"adminType\": \"ROLE_SUBADMIN\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "get", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "8f261b94-9875-416e-ab23-d07850651f92", + "name": "Get Single Identity", + "request": { + "name": "Get Single Identity", + "description": {}, + "url": { + "path": [ + "cc", + "api", + "user", + "get", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6bc06437-4b7f-46b8-a057-a4575c36e766", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "user", + "get", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"alias\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"uuid\": \"\",\n \"encryptionKey\": {},\n \"encryptionCheck\": {},\n \"status\": \"\",\n \"pending\": \"\",\n \"passwordResetSinceLastLogin\": \"\",\n \"usageCertAttested\": {},\n \"userFlags\": {},\n \"enabled\": \"\",\n \"altAuthVia\": \"\",\n \"altAuthViaIntegrationData\": {},\n \"kbaAnswers\": \"\",\n \"disablePasswordReset\": \"\",\n \"ptaSourceId\": {},\n \"supportsPasswordPush\": \"\",\n \"attributes\": {},\n \"externalId\": \"\",\n \"phone\": {},\n \"email\": \"\",\n \"personalEmail\": {},\n \"employeeNumber\": {},\n \"riskScore\": \"\",\n \"featureFlags\": {},\n \"feature\": [\n \"\",\n \"\"\n ],\n \"orgEncryptionKey\": \"\",\n \"orgEncryptionKeyId\": \"\",\n \"meta\": {},\n \"org\": {\n \"name\": \"\",\n \"scriptName\": \"\",\n \"mode\": \"\",\n \"numQuestions\": \"\",\n \"status\": \"\",\n \"maxRegisteredUsers\": \"\",\n \"pod\": \"\",\n \"pwdResetPersonalPhone\": \"\",\n \"pwdResetPersonalEmail\": \"\",\n \"pwdResetKba\": \"\",\n \"pwdResetEmail\": \"\",\n \"pwdResetDuo\": \"\",\n \"pwdResetPhoneMask\": \"\",\n \"authErrorText\": {},\n \"strongAuthKba\": \"\",\n \"strongAuthPersonalPhone\": \"\",\n \"strongAuthPersonalEmail\": \"\",\n \"productName\": \"\",\n \"kbaReqForAuthn\": \"\",\n \"kbaReqAnswers\": \"\",\n \"lockoutAttemptThreshold\": \"\",\n \"lockoutTimeMinutes\": \"\",\n \"usageCertRequired\": \"\",\n \"adminStrongAuthRequired\": \"\",\n \"enableExternalPasswordChange\": \"\",\n \"enablePasswordReplay\": \"\",\n \"enableAutomaticPasswordReplay\": \"\",\n \"notifyAuthenticationSettingChange\": \"\",\n \"netmasks\": {},\n \"countryCodes\": {},\n \"whiteList\": \"\",\n \"usernameEmptyText\": {},\n \"usernameLabel\": {},\n \"enableAutomationGeneration\": \"\",\n \"emailTestMode\": \"\",\n \"emailTestAddress\": \"\",\n \"orgType\": \"\",\n \"passwordReplayState\": \"\",\n \"systemNotificationConfig\": \"\",\n \"redirectPatterns\": \"\",\n \"maxClusterDebugHours\": \"\",\n \"brandName\": \"\",\n \"logo\": {},\n \"emailFromAddress\": {},\n \"standardLogoUrl\": {},\n \"narrowLogoUrl\": {},\n \"actionButtonColor\": \"\",\n \"activeLinkColor\": \"\",\n \"navigationColor\": \"\"\n },\n \"stepUpAuth\": \"\",\n \"bxInstallPrompted\": \"\",\n \"federatedLogin\": \"\",\n \"auth\": {\n \"service\": \"\",\n \"encryption\": \"\"\n },\n \"onNetwork\": \"\",\n \"onTrustedGeo\": \"\",\n \"loginUrl\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "source", + "description": "", + "item": [ + { + "name": "loadAccounts", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "4b06c1ce-e887-4dea-ad10-5f524be7c410", + "name": "Account Aggregation (File)", + "request": { + "name": "Account Aggregation (File)", + "description": { + "content": "Aggregates a delimited file for the given source. This only works for file-based sources.", + "type": "text/plain" + }, + "url": { + "path": [ + "cc", + "api", + "source", + "loadAccounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "disableOptimization", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "e46188fa-2e71-4b23-b082-0ffb59e027cc", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "source", + "loadAccounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "disableOptimization", + "value": "", + "type": "text" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "exportAccountFeed", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "3a302cdc-4c5e-4adb-9ad7-1c438c2d3071", + "name": "Export Account Feed", + "request": { + "name": "Export Account Feed", + "description": { + "content": "Exports a CSV of the accounts for a particular source.", + "type": "text/plain" + }, + "url": { + "path": [ + "cc", + "api", + "source", + "exportAccountFeed", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9785581c-2db2-4521-9fbc-70f71713ed83", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "source", + "exportAccountFeed", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "system", + "description": "", + "item": [ + { + "name": "refreshIdentities", + "description": "", + "item": [ + { + "id": "49b36b5d-0e2b-4724-b60b-8f16dd233114", + "name": "Refresh Identities", + "request": { + "name": "Refresh Identities", + "description": { + "content": "This kicks off an identity refresh for a specified set of identity attributes. This can be a long running process. IdentityNow has pre-scheduled versions of this task at set intervals and events already, so only run this when directed by SailPoint.\n\n_Note: If the identities specified by the filter do not exist, a full identity refresh will be run. Use with caution._\n\nRefresh Arguments:\n\n| Key | Description |\n|-----------------------|----------------------------------------------------|\n| correlateEntitlements | Analyzes entitlements, access profiles, and roles. |\n| promoteAttributes | Calculates identity attributes. |\n| refreshManagerStatus | Calculates manager correlation and manager status. |\n| synchronizeAttributes | Performs attribute sync provisioning. |\n| pruneIdentities | Removes any identities which don't have accounts. |\n| provision | Provisions any assigned roles or access profiles. |", + "type": "text/plain" + }, + "url": { + "path": [ + "cc", + "api", + "system", + "refreshIdentities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filter\": \"\",\n \"refreshArgs\": {\n \"correlateEntitlements\": \"\",\n \"promoteAttributes\": \"\",\n \"refreshManagerStatus\": \"\",\n \"synchronizeAttributes\": \"\",\n \"pruneIdentities\": \"\",\n \"provision\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "676255a7-e17d-46fa-9618-804dd967a515", + "name": "Successful response", + "originalRequest": { + "url": { + "path": [ + "cc", + "api", + "system", + "refreshIdentities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filter\": \"\",\n \"refreshArgs\": {\n \"correlateEntitlements\": \"\",\n \"promoteAttributes\": \"\",\n \"refreshManagerStatus\": \"\",\n \"synchronizeAttributes\": \"\",\n \"pruneIdentities\": \"\",\n \"provision\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "const domain = pm.environment.get('domain') ? pm.environment.get('domain') : pm.collectionVariables.get('domain')", + "const tokenUrl = 'https://' + pm.environment.get('tenant') + '.api.' + domain + '.com/oauth/token';", + "const clientId = pm.environment.get('clientId');", + "const clientSecret = pm.environment.get('clientSecret');", + "", + "const getTokenRequest = {", + " method: 'POST',", + " url: tokenUrl,", + " body: {", + " mode: 'formdata',", + " formdata: [{", + " key: 'grant_type',", + " value: 'client_credentials'", + " },", + " {", + " key: 'client_id',", + " value: clientId", + " },", + " {", + " key: 'client_secret',", + " value: clientSecret", + " }", + " ]", + " }", + "};", + "", + "", + "var moment = require('moment');", + "if (!pm.environment.has('tokenExpTime')) {", + " pm.environment.set('tokenExpTime', moment());", + "}", + "", + "if (moment(pm.environment.get('tokenExpTime')) <= moment() || !pm.environment.get('tokenExpTime') || !pm.environment.get('accessToken')) {", + " var time = moment();", + " time.add(12, 'hours');", + " pm.environment.set('tokenExpTime', time);", + " pm.sendRequest(getTokenRequest, (err, response) => {", + " const jsonResponse = response.json();", + " if (response.code != 200) {", + " throw new Error(`Unable to authenticate: ${JSON.stringify(jsonResponse)}`);", + " }", + " const newAccessToken = jsonResponse.access_token;", + " pm.environment.set('accessToken', newAccessToken);", + " });", + "", + "}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "key": "domain", + "value": "identitynow", + "type": "string" + }, + { + "key": "baseUrl", + "value": "https://{{tenant}}.api.{{domain}}.com", + "type": "string" + } + ], + "info": { + "_postman_id": "fce8ac31-cb89-4b05-8834-a485ae694712", + "name": "IdentityNow cc (private) APIs", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "", + "type": "text/plain" + } + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{accessToken}}", + "type": "string" + } + ] + } +} \ No newline at end of file diff --git a/postman/collections/sailpoint-api-v2.json b/postman/collections/sailpoint-api-v2.json new file mode 100644 index 0000000..dae9070 --- /dev/null +++ b/postman/collections/sailpoint-api-v2.json @@ -0,0 +1,1336 @@ +{ + "item": [ + { + "name": "org", + "description": "", + "item": [ + { + "id": "0e0aebeb-73a6-456e-9096-39494c8ef36d", + "name": "Retrieves your org settings.", + "request": { + "name": "Retrieves your org settings.", + "description": { + "content": "Retrieves information and operational settings for your org (as determined by the URL domain).", + "type": "text/plain" + }, + "url": { + "path": [ + "org" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "086aebc2-b0d6-4932-a38d-f0b55f9e3097", + "name": "OK.", + "originalRequest": { + "url": { + "path": [ + "org" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Entity tag.", + "type": "text/plain" + }, + "key": "ETag", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Last modified date.", + "type": "text/plain" + }, + "key": "Last-Modified", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Links to alternate or related resources.", + "type": "text/plain" + }, + "key": "Link", + "value": "" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"scriptName\": \"\",\n \"ssoDomain\": \"\",\n \"status\": \"test\",\n \"maxRegisteredIdentities\": \"\",\n \"identityCount\": \"\",\n \"kbaReqForAuthn\": \"\",\n \"kbaReqAnswers\": \"\",\n \"lockoutAttemptThreshold\": \"\",\n \"lockoutTimeMinutes\": \"\",\n \"usageCertRequired\": \"\",\n \"adminStrongAuthRequired\": \"\",\n \"enableExternalPasswordChange\": \"\",\n \"enablePasswordReplay\": \"\",\n \"enableAutomaticPasswordReplay\": \"\",\n \"netmasks\": [\n \"\",\n \"\"\n ],\n \"countryCodes\": [\n \"\",\n \"\"\n ],\n \"whiteList\": \"\",\n \"emailTestMode\": \"\",\n \"emailTestAddress\": \"\",\n \"usernameEmptyText\": \"\",\n \"usernameLabel\": \"\",\n \"enableAutomationGeneration\": \"\",\n \"passwordReplayState\": \"passive\",\n \"systemNotificationConfig\": {\n \"notifications\": [\n {\n \"type\": \"\",\n \"byEmail\": \"\",\n \"thresholds\": {\n \"healthy\": \"\",\n \"unhealthy\": \"\"\n }\n },\n {\n \"type\": \"\",\n \"byEmail\": \"\",\n \"thresholds\": {\n \"healthy\": \"\",\n \"unhealthy\": \"\"\n }\n }\n ],\n \"recipientType\": \"specificIdentities\"\n },\n \"systemNotificationEmails\": [\n \"\",\n \"\"\n ],\n \"loginUrl\": \"\",\n \"redirectPatterns\": [\n \"\",\n \"\"\n ],\n \"styleHash\": \"\",\n \"approvalConfig\": {\n \"daysTillEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApprover\": \"\"\n },\n \"ssoPartnerSource\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "431cbe95-7e84-4d9f-954b-071ce6486b62", + "name": "Updates one or more org attributes.", + "request": { + "name": "Updates one or more org attributes.", + "description": { + "content": "Updates one or more attributes for your org.", + "type": "text/plain" + }, + "url": { + "path": [ + "org" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"countryCodes\": [\n \"\",\n \"\"\n ],\n \"enableExternalPasswordChange\": \"\",\n \"enableAutomaticPasswordReplay\": \"\",\n \"enableAutomationGeneration\": \"\",\n \"kbaReqAnswers\": \"\",\n \"kbaReqForAuthn\": \"\",\n \"lockoutAttemptThreshold\": \"\",\n \"lockoutTimeMinutes\": \"\",\n \"loginUrl\": \"\",\n \"netmasks\": [\n \"\",\n \"\"\n ],\n \"notifyAuthenticationSettingChange\": \"\",\n \"passwordReplayState\": \"passive\",\n \"preferredIdentityInviteTemplate\": \"\",\n \"redirectPatterns\": [\n \"\",\n \"\"\n ],\n \"ssoPartnerSource\": \"\",\n \"systemNotificationEmails\": [\n \"\",\n \"\"\n ],\n \"trackAnalytics\": \"\",\n \"usageCertRequired\": \"\",\n \"usageCertText\": \"\",\n \"usernameEmptyText\": \"\",\n \"usernameLabel\": \"\",\n \"whiteList\": \"\",\n \"approvalConfig\": {\n \"daysTillEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApprover\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "0209541e-c2b1-4ddf-bed6-8292e786e116", + "name": "OK.", + "originalRequest": { + "url": { + "path": [ + "org" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"countryCodes\": [\n \"\",\n \"\"\n ],\n \"enableExternalPasswordChange\": \"\",\n \"enableAutomaticPasswordReplay\": \"\",\n \"enableAutomationGeneration\": \"\",\n \"kbaReqAnswers\": \"\",\n \"kbaReqForAuthn\": \"\",\n \"lockoutAttemptThreshold\": \"\",\n \"lockoutTimeMinutes\": \"\",\n \"loginUrl\": \"\",\n \"netmasks\": [\n \"\",\n \"\"\n ],\n \"notifyAuthenticationSettingChange\": \"\",\n \"passwordReplayState\": \"passive\",\n \"preferredIdentityInviteTemplate\": \"\",\n \"redirectPatterns\": [\n \"\",\n \"\"\n ],\n \"ssoPartnerSource\": \"\",\n \"systemNotificationEmails\": [\n \"\",\n \"\"\n ],\n \"trackAnalytics\": \"\",\n \"usageCertRequired\": \"\",\n \"usageCertText\": \"\",\n \"usernameEmptyText\": \"\",\n \"usernameLabel\": \"\",\n \"whiteList\": \"\",\n \"approvalConfig\": {\n \"daysTillEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApprover\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "Entity tag.", + "type": "text/plain" + }, + "key": "ETag", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Last modified date.", + "type": "text/plain" + }, + "key": "Last-Modified", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Links to alternate or related resources.", + "type": "text/plain" + }, + "key": "Link", + "value": "" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"scriptName\": \"\",\n \"ssoDomain\": \"\",\n \"status\": \"test\",\n \"maxRegisteredIdentities\": \"\",\n \"identityCount\": \"\",\n \"kbaReqForAuthn\": \"\",\n \"kbaReqAnswers\": \"\",\n \"lockoutAttemptThreshold\": \"\",\n \"lockoutTimeMinutes\": \"\",\n \"usageCertRequired\": \"\",\n \"adminStrongAuthRequired\": \"\",\n \"enableExternalPasswordChange\": \"\",\n \"enablePasswordReplay\": \"\",\n \"enableAutomaticPasswordReplay\": \"\",\n \"netmasks\": [\n \"\",\n \"\"\n ],\n \"countryCodes\": [\n \"\",\n \"\"\n ],\n \"whiteList\": \"\",\n \"emailTestMode\": \"\",\n \"emailTestAddress\": \"\",\n \"usernameEmptyText\": \"\",\n \"usernameLabel\": \"\",\n \"enableAutomationGeneration\": \"\",\n \"passwordReplayState\": \"passive\",\n \"systemNotificationConfig\": {\n \"notifications\": [\n {\n \"type\": \"\",\n \"byEmail\": \"\",\n \"thresholds\": {\n \"healthy\": \"\",\n \"unhealthy\": \"\"\n }\n },\n {\n \"type\": \"\",\n \"byEmail\": \"\",\n \"thresholds\": {\n \"healthy\": \"\",\n \"unhealthy\": \"\"\n }\n }\n ],\n \"recipientType\": \"specificIdentities\"\n },\n \"systemNotificationEmails\": [\n \"\",\n \"\"\n ],\n \"loginUrl\": \"\",\n \"redirectPatterns\": [\n \"\",\n \"\"\n ],\n \"styleHash\": \"\",\n \"approvalConfig\": {\n \"daysTillEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApprover\": \"\"\n },\n \"ssoPartnerSource\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "workgroups", + "description": "", + "item": [ + { + "id": "9aa7ab0a-23f1-4edd-bc62-a6f504763ce5", + "name": "List Work Groups", + "request": { + "name": "List Work Groups", + "description": { + "content": "This API returns a list of work groups", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the following syntax.\n[{property:name, value: \"Tyler\", operation: EQ}]", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9ee13479-e78d-4503-a28e-20ef722da9cb", + "name": "List of work group objects", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the following syntax.\n[{property:name, value: \"Tyler\", operation: EQ}]", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"connectionCount\": \"\",\n \"created\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"memberCount\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"displayName\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"connectionCount\": \"\",\n \"created\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"memberCount\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"displayName\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1eb000b4-1dd0-4f58-925b-81c0c6e15843", + "name": "Create Work Group", + "request": { + "name": "Create Work Group", + "description": { + "content": "This API allows you to create a work group", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b22a1a86-ecd4-4969-9514-78bd4cb9520d", + "name": "List of work group objects", + "originalRequest": { + "url": { + "path": [ + "workgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"connectionCount\": \"\",\n \"created\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"memberCount\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"displayName\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"connectionCount\": \"\",\n \"created\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"memberCount\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"displayName\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{workgroupId}", + "description": "", + "item": [ + { + "id": "5506ab56-6970-42b0-ba50-90df4b47aa8c", + "name": "Get Work Group By Id", + "request": { + "name": "Get Work Group By Id", + "description": { + "content": "This API returns the details for a single workgroup based on the ID", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups", + ":workgroupId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "workgroupId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1fa37f55-b9a9-4249-bf55-69048de5f032", + "name": "Workgroup object", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":workgroupId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"connectionCount\": \"\",\n \"created\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"memberCount\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"displayName\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "464746ef-63fa-4955-9c0a-7bac6dfa2bad", + "name": "Update Work Group By Id", + "request": { + "name": "Update Work Group By Id", + "description": { + "content": "This API updates and returns the details for a single workgroup based on the ID", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups", + ":workgroupId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "workgroupId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f925e560-99b2-4586-a5cc-3965f25572a7", + "name": "Workgroup object", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":workgroupId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"connectionCount\": \"\",\n \"created\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"memberCount\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"owner\": {\n \"displayName\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f30191af-26da-4a7b-84de-5c4a47c1985a", + "name": "Delete Work Group By Id", + "request": { + "name": "Delete Work Group By Id", + "description": { + "content": "This API deletes a single workgroup based on the ID", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups", + ":workgroupId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "workgroupId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "760da5c6-ad93-42a1-aed2-56c0cf7474b9", + "name": "Empty response on successful deletion", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":workgroupId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "members", + "description": "", + "item": [ + { + "id": "71d1ad39-f66c-4938-aa79-71e5897f450b", + "name": "List Work Group Members", + "request": { + "name": "List Work Group Members", + "description": { + "content": "This API returns the members of a work group", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups", + ":workgroupId", + "members" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the following syntax.\n[{property:name, value: \"Tyler\", operation: EQ}]", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "workgroupId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3d2a6b6b-b621-4437-a689-0f024949dc34", + "name": "List of work group member objects", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":workgroupId", + "members" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Filter results using the following syntax.\n[{property:name, value: \"Tyler\", operation: EQ}]", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"alias\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"alias\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2a58b308-e7ee-4bd1-a4dc-eea78016e830", + "name": "Modify Work Group Members", + "request": { + "name": "Modify Work Group Members", + "description": { + "content": "This API allows you to modify the members of a work group", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups", + ":workgroupId", + "members" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "workgroupId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"add\": [\n \"\",\n \"\"\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "069df703-74f7-4e17-a70b-3a2b97f671ae", + "name": "Empty response on successful deletion", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":workgroupId", + "members" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"add\": [\n \"\",\n \"\"\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "connections", + "description": "", + "item": [ + { + "id": "ece0ac5f-0229-4c7f-b0a1-d5157e1d3958", + "name": "List Work Group Connections", + "request": { + "name": "List Work Group Connections", + "description": { + "content": "This API returns the connections of a work group", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups", + ":workgroupId", + "connections" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "workgroupId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "bf75679d-9046-4c8e-b1ed-084e65aec0a0", + "name": "List of work group connection objects", + "originalRequest": { + "url": { + "path": [ + "workgroups", + ":workgroupId", + "connections" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"connectionType\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"objectId\": \"\",\n \"objectType\": \"\",\n \"workgroupId\": \"\"\n },\n {\n \"connectionType\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"objectId\": \"\",\n \"objectType\": \"\",\n \"workgroupId\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "6ae052fe-79dd-4925-a613-ae7f8ead696e", + "name": "Bulk delete work groups", + "request": { + "name": "Bulk delete work groups", + "description": { + "content": "This API allows you to bulk-delete work groups", + "type": "text/plain" + }, + "url": { + "path": [ + "workgroups", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "411fb7e2-8c00-443c-bc0b-4588825e1cdb", + "name": "List of work group objects", + "originalRequest": { + "url": { + "path": [ + "workgroups", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"deleted\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n \"\",\n \"\"\n ],\n \"notFound\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "const domain = pm.environment.get('domain') ? pm.environment.get('domain') : pm.collectionVariables.get('domain')", + "const tokenUrl = 'https://' + pm.environment.get('tenant') + '.api.' + domain + '.com/oauth/token';", + "const clientId = pm.environment.get('clientId');", + "const clientSecret = pm.environment.get('clientSecret');", + "", + "const getTokenRequest = {", + " method: 'POST',", + " url: tokenUrl,", + " body: {", + " mode: 'formdata',", + " formdata: [{", + " key: 'grant_type',", + " value: 'client_credentials'", + " },", + " {", + " key: 'client_id',", + " value: clientId", + " },", + " {", + " key: 'client_secret',", + " value: clientSecret", + " }", + " ]", + " }", + "};", + "", + "", + "var moment = require('moment');", + "if (!pm.environment.has('tokenExpTime')) {", + " pm.environment.set('tokenExpTime', moment());", + "}", + "", + "if (moment(pm.environment.get('tokenExpTime')) <= moment() || !pm.environment.get('tokenExpTime') || !pm.environment.get('accessToken')) {", + " var time = moment();", + " time.add(12, 'hours');", + " pm.environment.set('tokenExpTime', time);", + " pm.sendRequest(getTokenRequest, (err, response) => {", + " const jsonResponse = response.json();", + " if (response.code != 200) {", + " throw new Error(`Unable to authenticate: ${JSON.stringify(jsonResponse)}`);", + " }", + " const newAccessToken = jsonResponse.access_token;", + " pm.environment.set('accessToken', newAccessToken);", + " });", + "", + "}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "key": "domain", + "value": "identitynow", + "type": "string" + }, + { + "key": "baseUrl", + "value": "https://{{tenant}}.api.{{domain}}.com", + "type": "string" + } + ], + "info": { + "_postman_id": "79bdf996-5604-48d6-b0c1-d81aaf41e610", + "name": "SailPoint SaaS API", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "", + "type": "text/plain" + } + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{accessToken}}", + "type": "string" + } + ] + } +} \ No newline at end of file diff --git a/postman/collections/sailpoint-api-v3.json b/postman/collections/sailpoint-api-v3.json new file mode 100644 index 0000000..15cca6e --- /dev/null +++ b/postman/collections/sailpoint-api-v3.json @@ -0,0 +1,101548 @@ +{ + "item": [ + { + "name": "access-profiles", + "description": "", + "item": [ + { + "id": "b1eda4ac-235c-4ec5-8881-a9eeb198d4c0", + "name": "List Access Profiles", + "request": { + "name": "List Access Profiles", + "description": { + "content": "This API returns a list of Access Profiles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8dcdbc03-119d-4947-95e8-3e33bb9ae055", + "name": "List of Access Profiles", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"owner\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n },\n {\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"OR\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62d92a3a-2bb4-443a-b445-6871065f3d79", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1c17dea-56c9-4364-9161-3bdddbab33c8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "885faa50-6806-45d0-ade4-800a14b0e76f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d9cba983-6605-4a55-b099-8115d21832fd", + "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": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6165d7ff-4f79-4216-88dd-74e1b5ba45e0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "10082161-3ce1-4583-977e-bf0179129f48", + "name": "Create an Access Profile", + "request": { + "name": "Create an Access Profile", + "description": { + "content": "This API creates an Access Profile.\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile's Source.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "0a4819e1-623a-4463-bc6a-33b1781de35c", + "name": "Access Profile created", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4246f646-5c2c-4277-9938-dd7a84f4bd9a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8482e20d-d84d-4bd1-8491-423e352bd237", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d72f77b4-bd7f-4045-b0b5-3bc30aecbe2d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf4f7e60-2d24-4c62-93ee-39a93c6e57b7", + "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": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "be6ad6f3-0096-4724-8db0-f5edc2c9eff9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "53662903-c1cc-42c6-bf85-e000a556914e", + "name": "Get an Access Profile", + "request": { + "name": "Get an Access Profile", + "description": { + "content": "This API returns an Access Profile by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "b16a2a8c-4030-4378-8549-5a84c4a14372", + "name": "An AccessProfile", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c024f77a-8d94-413d-8bf7-9c87dd2fb03a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30432a4a-bba7-4817-abda-1a93e3236054", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "363c79cb-5f00-44f8-a39f-5b1c3bfa8044", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c5cd1655-68e3-4bef-aaaa-5e7988c431cc", + "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": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "83d5caca-bd49-4fca-a1d9-62924c20dd8d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "cde330d4-a492-4fe8-a7d4-b89a0cd325e0", + "name": "Patch a specified Access Profile", + "request": { + "name": "Patch a specified Access Profile", + "description": { + "content": "This API updates an existing Access Profile. The following fields are patchable:\n\n**name**\n\n**description**\n\n**enabled**\n\n**owner**\n\n**requestable**\n\n**accessRequestConfig**\n\n**revokeRequestConfig**\n\n**segments**\n\n**entitlements**\n\n**provisioningCriteria**\n\n**source** (must be updated with entitlements belonging to new source in the same API call)\n\nIf you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.\n> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.\n\n> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source.\n\n> Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3b75286b-4297-4a61-9fb9-77e9b863c9c1", + "name": "Responds with the Access Profile as updated.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"name\": \"\"\n }\n ],\n \"requestable\": \"\",\n \"accessRequestConfig\": {\n \"commentsRequired\": \"\",\n \"denialCommentsRequired\": \"\",\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"APP_OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"SOURCE_OWNER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"provisioningCriteria\": {\n \"operation\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"NOT_EQUALS\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"children\": [\n {\n \"operation\": \"HAS\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c20eae7e-e8a7-4bf8-b02d-8249291cf610", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ee2f8eb-5832-4a06-af87-7d397a9d4782", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34871567-a7f7-4f5f-b7fd-5c61edfc951c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a646286c-f4dc-4deb-9574-4210ab554449", + "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": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fd129d01-308b-4b9a-aee4-4e87015a1a94", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "entitlements", + "description": "", + "item": [ + { + "id": "d0adb269-b0d9-4b83-b483-f8fb6bcedce0", + "name": "List Access Profile's Entitlements", + "request": { + "name": "List Access Profile's Entitlements", + "description": { + "content": "This API lists the Entitlements associated with a given Access Profile\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9e443c2f-d781-4d83-9039-d1f943b137e6", + "name": "List of Entitlements", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"attributes\": {\n \"ut_e\": -70952386,\n \"culpa_485\": -65316604.788748346\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"source\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n \"attributes\": {\n \"ex_d\": -44642937,\n \"ut_e\": 49894671,\n \"cupidatat43\": false\n },\n \"segments\": [\n \"\",\n \"\"\n ],\n \"directPermissions\": [\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n },\n {\n \"rights\": [\n \"\",\n \"\"\n ],\n \"target\": \"\"\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65a748af-0154-46b6-8ff7-85395620fcef", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fdfa8ef0-181c-490b-ad40-779063562a33", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4578e70-0911-44c8-a24c-2c3a8641f5b7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "938e8f7d-2557-400a-8951-c9e109346715", + "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": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b019796a-747d-425f-a54d-90940b1e9ce7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, attribute, value, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "037594ee-7591-44d5-a808-0e72ba40df10", + "name": "Delete Access Profile(s)", + "request": { + "name": "Delete Access Profile(s)", + "description": { + "content": "This API initiates a bulk deletion of one or more Access Profiles.\n\nBy default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "babc2923-0804-4cf3-8f2c-8840a0b3f938", + "name": "Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"taskId\": \"\",\n \"pending\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9fafc30-be57-4b3a-b805-b8ead2b99d39", + "name": "Returned if at least one deletion will be performed.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"taskId\": \"\",\n \"pending\": [\n \"\",\n \"\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"accessProfileId\": \"\",\n \"usedBy\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "296142db-b3a9-4647-ae27-59e5b310a76b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "87077f5c-bf03-48c7-ac42-a0db01ec865e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31748589-0f89-4bca-b16d-f4813220f662", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "628673c9-31e4-4cb7-b3bb-dd8f673ef860", + "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": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa7e3d61-d081-4ad5-9931-a53c864a3f54", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accessProfileIds\": [\n \"\",\n \"\"\n ],\n \"bestEffortOnly\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "access-requests", + "description": "", + "item": [ + { + "id": "6591ab27-65e3-4ee0-8096-6a4c3cfb7367", + "name": "Submit an Access Request", + "request": { + "name": "Submit an Access Request", + "description": { + "content": "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. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-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 only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate.\n* Roles, Access Profiles, and Entitlements can be requested for revocation.\n* Revoke requests for entitlements are limited to 1 entitlement per access request currently.\n* [Roles, Access Profiles] removeDate can be specified if access don't have a sunset date or if a revoke access with a removeDate earlier than the current endDate.\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\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", + "type": "text/plain" + }, + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"amet__d\": \"\",\n \"sit72\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"consectetur_0\": \"\",\n \"ad648\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"dolor__\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a95e05b7-d915-497a-a7f4-b471600236a6", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"amet__d\": \"\",\n \"sit72\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"consectetur_0\": \"\",\n \"ad648\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"dolor__\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "baadb9cb-208e-4904-9ccb-77828b7b3ca4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"amet__d\": \"\",\n \"sit72\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"consectetur_0\": \"\",\n \"ad648\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"dolor__\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef41a8f1-ec83-48cc-a8c5-e380771a2cc6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"amet__d\": \"\",\n \"sit72\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"consectetur_0\": \"\",\n \"ad648\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"dolor__\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "913bd388-38f7-47b9-87b4-b174d4cfc2fc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"amet__d\": \"\",\n \"sit72\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"consectetur_0\": \"\",\n \"ad648\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"dolor__\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "78163fa3-7999-4edd-aa22-45fc7a9ffd70", + "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": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"amet__d\": \"\",\n \"sit72\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"consectetur_0\": \"\",\n \"ad648\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"dolor__\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e272337-0944-4161-a0c9-ed9a50cb9469", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"requestedFor\": [\n \"\",\n \"\"\n ],\n \"requestedItems\": [\n {\n \"id\": \"\",\n \"type\": \"ROLE\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"amet__d\": \"\",\n \"sit72\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"comment\": \"\",\n \"clientMetadata\": {\n \"consectetur_0\": \"\",\n \"ad648\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"requestType\": \"REVOKE_ACCESS\",\n \"clientMetadata\": {\n \"dolor__\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "cancel", + "description": "", + "item": [ + { + "id": "785c4730-8d0d-4523-95a0-21dacb853115", + "name": "Cancel Access Request", + "request": { + "name": "Cancel Access Request", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "083bbd3d-e2d1-4182-a3ed-18bdd0dc7eee", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fcaecdc2-2651-42b0-9717-a048e6cde80a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed433344-c7fb-43af-9e2c-3f584d642d9a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c612aef0-1506-4d08-99c7-c38f31403c11", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "429f10a2-98a1-4bfa-8ae7-22eda69482e3", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0f41a7c1-5861-4118-837b-69b209f3b45d", + "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": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d0c7e05a-6c0b-4537-baa3-53b6b3eca48b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-requests", + "cancel" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountActivityId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "access-request-config", + "description": "", + "item": [ + { + "id": "face877d-3c88-4032-a1a5-e349ae09b74d", + "name": "Get Access Request Configuration", + "request": { + "name": "Get Access Request Configuration", + "description": { + "content": "This endpoint returns the current access-request configuration.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "2330b490-1aa9-4ae3-8361-7b97b1c9d061", + "name": "Access Request Configuration Details.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e92a1d97-2a26-4f4e-9350-f7bb6001d2ad", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "679a8839-72e3-48d4-9057-2823b0885642", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "779ebac4-3f45-4079-9846-7f14e701b8eb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ecbce54-91f6-49c5-a621-f33fab63b76d", + "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": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "66f96e15-2a85-4cc8-aa68-a954b485195e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "307b28bb-a974-40d2-9d13-9ca3f637340a", + "name": "Update Access Request Configuration", + "request": { + "name": "Update Access Request Configuration", + "description": { + "content": "This endpoint replaces the current access-request configuration.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4957dc69-3870-497e-985c-265460b51194", + "name": "Access Request Configuration Details.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e6a333f1-d0b7-4d28-9474-56d774d493ed", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17cfa922-7e03-424d-95d3-51b9c6471b79", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8aaf543-0ed0-45d4-8b73-c705eb50202e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efe006bf-f202-457d-a2a3-52c6dea1e982", + "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": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c682db13-2608-4453-a5ac-847bca9a2d18", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"approvalsMustBeExternal\": \"\",\n \"autoApprovalEnabled\": \"\",\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": \"\",\n \"allowRequestOnBehalfOfEmployeeByManager\": \"\"\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": \"\",\n \"daysBetweenReminders\": \"\",\n \"maxReminders\": \"\",\n \"fallbackApproverRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": \"\",\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"sourceOwner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "access-request-status", + "description": "", + "item": [ + { + "id": "bf5f0d44-f6d2-4363-bca8-782c981b351d", + "name": "Access Request Status", + "request": { + "name": "Access Request Status", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ab823568-6580-4f75-a149-8f72e392ae56", + "name": "List of requested item status.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"type\": \"ROLE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n ],\n \"state\": \"PROVISIONING_VERIFICATION_PENDING\",\n \"approvalDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"EXPIRED\",\n \"scheme\": \"APP_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"REJECTED\",\n \"scheme\": \"APP_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"APPROVED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ]\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"PENDING\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n }\n ]\n }\n ],\n \"accountActivityItemId\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"modified\": \"\",\n \"created\": \"\",\n \"requester\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"Utfb\": \"\",\n \"occaecatd\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"\",\n \"reviewer\": \"\",\n \"decision\": \"REJECTED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"COMPLETED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n },\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"COMPLETED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n }\n ],\n \"description\": \"\",\n \"removeDate\": \"\",\n \"cancelable\": \"\",\n \"accessRequestId\": \"\",\n \"clientMetadata\": {\n \"ex_39\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"\",\n \"owner\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n ],\n \"state\": \"PROVISIONING_VERIFICATION_PENDING\",\n \"approvalDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"APPROVED\",\n \"scheme\": \"GOVERNANCE_GROUP\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"REJECTED\",\n \"scheme\": \"ROLE_OWNER\",\n \"errorMessages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"comment\": \"\",\n \"removeDate\": \"\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"APPROVED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ]\n },\n {\n \"forwarded\": \"\",\n \"originalOwner\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"currentOwner\": {\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"modified\": \"\",\n \"status\": \"APPROVED\",\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"SELF_REVIEW_DELEGATION\"\n }\n ]\n }\n ],\n \"accountActivityItemId\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"modified\": \"\",\n \"created\": \"\",\n \"requester\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"sodViolationContext\": {\n \"state\": \"ERROR\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"ad764\": \"\",\n \"anim_6\": \"\",\n \"dolor_a9\": \"\",\n \"magna_d\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n },\n \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"\",\n \"reviewer\": \"\",\n \"decision\": \"REJECTED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"EXECUTING\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n },\n {\n \"started\": \"\",\n \"finished\": \"\",\n \"name\": \"\",\n \"state\": \"EXECUTING\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"\"\n }\n ],\n \"description\": \"\",\n \"removeDate\": \"\",\n \"cancelable\": \"\",\n \"accessRequestId\": \"\",\n \"clientMetadata\": {\n \"exercitation_a7f\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "456476d2-2c30-4994-aead-5d12a2aac929", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4c41a7f0-7db2-4c1f-8246-b2d740c15f56", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "58778ba3-3c6a-40c2-9ca3-ced9c6c2ca4e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af7df485-fcba-425b-a360-bb35a2ffb850", + "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": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e3a2b8c-cdb1-4554-972d-ea53cfa656de", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.", + "type": "text/plain" + }, + "key": "offset", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "access-request-approvals", + "description": "", + "item": [ + { + "name": "pending", + "description": "", + "item": [ + { + "id": "dfd153ea-2990-401f-9c5d-502ccf2d6b50", + "name": "Pending Access Request Approvals List", + "request": { + "name": "Pending Access Request Approvals List", + "description": { + "content": "This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "fc52c58c-4759-4838-9ced-1c8c3a645c2e", + "name": "List of Pending Approvals.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"actionInProcess\": \"APPROVED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"ERROR\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"ut00\": \"\",\n \"amet_cf\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"MANUAL_REASSIGNMENT\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"actionInProcess\": \"REJECTED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"do_d\": \"\",\n \"nisi_33\": \"\",\n \"non7_c\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "647117bf-2263-4308-a62b-20f3cfd9ed44", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0249c250-0919-46e5-8256-90b24e83506e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8be2c378-93b4-41c6-8d5e-d978720b0ad1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bcbbde4c-74e0-4810-bb73-e350b7c33a2c", + "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": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7dfe6c17-edd1-4ef2-8120-b1ed2af164c0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "pending" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "completed", + "description": "", + "item": [ + { + "id": "8ad3eae2-b184-4573-a404-21ee7cc1b989", + "name": "Completed Access Request Approvals List", + "request": { + "name": "Completed Access Request Approvals List", + "description": { + "content": "This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ef9faea5-ef42-4016-8fc1-9b968533afe7", + "name": "List of Completed Approvals.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"ACCOUNT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"reviewerComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"state\": \"REJECTED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"ullamco_f\": \"\",\n \"adipisicing_2df\": \"\",\n \"nulla02c\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"requestCreated\": \"\",\n \"requestType\": \"REVOKE_ACCESS\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedFor\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewedBy\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"owner\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestedObject\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"reviewerComment\": {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n },\n {\n \"comment\": \"\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n },\n {\n \"oldApproverName\": \"\",\n \"newApproverName\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"forwarderName\": \"\",\n \"reassignmentType\": \"AUTO_ESCALATION\"\n }\n ],\n \"commentRequiredWhenRejected\": \"\",\n \"state\": \"REJECTED\",\n \"removeDate\": \"\",\n \"removeDateUpdateRequested\": \"\",\n \"currentRemoveDate\": \"\",\n \"sodViolationContext\": {\n \"state\": \"ERROR\",\n \"uuid\": \"\",\n \"violationCheckResult\": {\n \"message\": {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n \"clientMetadata\": {\n \"occaecat_9\": \"\",\n \"ut_4\": \"\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": \"\",\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"existing\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0ee91de-5685-4c9a-ab56-9c968a8f838d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c7b74432-7ee8-4faa-b9d2-bc09511ee25a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cc4cdd8-ea7e-4cc8-a380-f5f429e62eae", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "387636a4-c5f7-4804-83fa-1b9953f8a062", + "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": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16ed2d8e-e68c-411d-885d-1fd563a07c55", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{approvalId}", + "description": "", + "item": [ + { + "name": "approve", + "description": "", + "item": [ + { + "id": "32c2fb0f-2f5b-430d-9771-e5dbe9517024", + "name": "Approves an access request approval.", + "request": { + "name": "Approves an access request approval.", + "description": { + "content": "This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "approvalId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3d8f50f2-7eff-46b9-a264-fa1a27a7cbce", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2ebb9ab-bef4-4860-917a-d07a3cec2b20", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dbd689b1-ea1e-4f6b-8123-b57d91d8df49", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "daddeb4f-0680-41eb-8949-e7180bc45dcf", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2e74793-c6ad-45c7-a8b7-f506b00f0951", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "168e67cf-0c02-4b87-aeec-40d1e36074c5", + "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": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9381c1f8-7410-4a0e-b560-18f1beabdfd5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reject", + "description": "", + "item": [ + { + "id": "ecec201a-8e81-4ab0-b052-0db2b7263110", + "name": "Rejects an access request approval.", + "request": { + "name": "Rejects an access request approval.", + "description": { + "content": "This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "approvalId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f82e2733-0b19-463f-bd51-1653a6e4e513", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5efa751d-0726-4363-8a62-51ec0e49ffa8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0378e48c-8582-4a01-8aec-063deb27573d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "69701d3a-a5cc-4e94-abb4-41f5802ae929", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f4b92a8-7fb2-4c6d-a2a1-91fb8416c34b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d58e2105-7f39-47eb-bc6f-5dd9bb9ef6ad", + "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": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "620d7fb1-4e27-4cab-aec2-26653e56fc4d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\",\n \"author\": {\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "forward", + "description": "", + "item": [ + { + "id": "db336c91-14ec-493e-a05c-977f5eff3469", + "name": "Forwards an access request approval.", + "request": { + "name": "Forwards an access request approval.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "approvalId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "81ffacc2-aff8-4986-a682-76fc2b21fedd", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b65b6ca6-7106-4df8-8d69-3f9a93441922", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c6cf76cc-677d-4ffb-a8c5-581ce471498a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "88b0cb7d-c2cc-4df7-a4ac-5cb6470d736f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "097acbd5-fe48-44a5-aca4-718dfd9b6670", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "232fed48-8ab0-496c-9941-6342299873a2", + "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": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bac8f4b6-621a-41f8-bb36-c4ab1d7aec75", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + ":approvalId", + "forward" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"newOwnerId\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "approval-summary", + "description": "", + "item": [ + { + "id": "f07b37ab-f0da-4e8c-986f-16487a19e9b4", + "name": "Get the number of access-requests-approvals", + "request": { + "name": "Get the number of access-requests-approvals", + "description": { + "content": "This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.", + "type": "text/plain" + }, + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "89ba0580-1e6e-43bb-ba1d-8871984a9396", + "name": "Number of pending, approved, rejected access request approvals.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"pending\": \"\",\n \"approved\": \"\",\n \"rejected\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ffc56f5c-244b-4b34-b777-7455b9a19954", + "name": "Client Error - Returned if the query parameter is invalid.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "23ee660c-abc4-4c55-958d-9723dff79a6d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95798370-d90e-4cb2-a2d1-ca17e95122a8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2bf55f80-537c-42d8-9ced-6d9ef8351ac7", + "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": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "08c88981-b539-41e0-8c22-85bd5b6b4c1a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "access-request-approvals", + "approval-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format", + "type": "text/plain" + }, + "key": "from-date", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "accounts", + "description": "", + "item": [ + { + "id": "878292c1-a29f-4f96-883c-a5d9f3d95bdd", + "name": "Accounts List", + "request": { + "name": "Accounts List", + "description": { + "content": "This returns a list of accounts. \nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9a06f7ea-81a2-4294-bda2-b07e0d6b0323", + "name": "List of account objects", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"attributes\": {\n \"proident_5\": 261450.21101675928,\n \"in_f\": -78043694.56716055,\n \"do_d\": false,\n \"adipisicing_d\": false\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n },\n {\n \"attributes\": {\n \"sint43\": -45683102.85556025\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fd2a2cec-925c-4cad-a972-b221e7eba2fc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32eac8ce-e469-4fde-a3cd-5cffd65eba6c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df85a5ef-8900-45b2-bb14-d51284052fbe", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3105b8f7-5518-4dff-bb0f-6dd37a0563e2", + "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": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9138084d-c826-4156-852e-95407c9c1ddc", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**, **modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2241a607-a5ac-4fe3-9d0b-cc18457d00b5", + "name": "Create Account", + "request": { + "name": "Create Account", + "description": { + "content": "This API submits an account creation task and returns the task ID. \nThe `sourceId` where this account will be created must be included in the `attributes` object.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ed7d2db8-f711-43d7-a640-c44da345e2ef", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7de33b0c-c6a7-42bd-ad06-796aeecf03a3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d1dc216-41db-4c4e-8637-af864ff0edf3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fab285ba-d697-49e1-9cde-3a400a0530b3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "247a60d6-c493-416f-a480-6f2d38dfcd61", + "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": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d11a2e27-fd4a-439d-ae46-006360dc2ce0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"sourceId\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "6585fa9e-cf62-440a-b64c-4368114750bf", + "name": "Account Details", + "request": { + "name": "Account Details", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e1ac78ab-84c1-45f4-bb07-7a0b915cd57c", + "name": "An account object", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"velit_40\": 35533775,\n \"fugiat_39\": 36806212.510109484\n },\n \"authoritative\": \"\",\n \"disabled\": \"\",\n \"hasEntitlements\": \"\",\n \"locked\": \"\",\n \"manuallyCorrelated\": \"\",\n \"name\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"sourceName\": \"\",\n \"systemAccount\": \"\",\n \"uncorrelated\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"identityId\": \"\",\n \"description\": \"\",\n \"uuid\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6faceda5-c3ad-4ec7-ae2f-1e8e4ba2a7bd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "80069be9-f7ed-4703-b67c-42f6bc83f520", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efbbb92e-7f5d-4c87-a538-75cc64f17a86", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d85060c-c7a3-4e75-80ef-35684411c90d", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40eba81b-214f-41ad-98e8-05da2e44b3bf", + "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": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31356d17-b0ed-49ca-895f-c5015f95a66a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a575cff3-7472-4371-8e3e-14f73d1b5aec", + "name": "Update Account", + "request": { + "name": "Update Account", + "description": { + "content": "Use this API to modify the following fields:\n* `identityId`\n\n* `manuallyCorrelated`\n\n>**NOTE: All other fields cannot be modified.**\n\nThe request must provide a JSONPatch payload.\n\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ccb9e5ad-c0f3-427a-b32c-7928586f51fb", + "name": "Accepted. Update request accepted and is in progress.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae136d13-1b84-435f-bc65-6d0c15e2efbc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "409afbba-7d8c-471e-87ff-add6881fd8f3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1f7e120b-8859-4ab0-8fd4-e2d1cffdd3d2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f1caa1aa-4347-48c8-bba7-22a0e21cc01f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e575dfb3-8176-4479-969b-a717459d0695", + "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": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a9710a5-e9ed-4b34-b84c-5020337c2b26", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4d3bbdb4-38a0-41cb-af9a-d343deeb2ecf", + "name": "Update Account", + "request": { + "name": "Update Account", + "description": { + "content": "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.**", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"ut_c93\": \"est\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f484d3b7-e433-434a-87e4-1128dfda3076", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"ut_c93\": \"est\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9e7bc267-ed74-45e3-876f-5cd47296b1e8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"ut_c93\": \"est\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "82502a10-ec22-4dcf-8183-933a9e1cacb6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"ut_c93\": \"est\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da4b193c-55d5-4625-a0c7-c328922e67d5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"ut_c93\": \"est\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7de845c6-f55f-446d-b80d-70a2169df347", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"ut_c93\": \"est\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "403c0173-c25f-48c0-a3e9-0aa5e4cd9afc", + "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": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"ut_c93\": \"est\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "503f7755-1b6e-4dbe-a6aa-abff38d9f5b2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"ut_c93\": \"est\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5fc7e509-cdf1-4c04-819e-1ae4a5e240e9", + "name": "Delete Account", + "request": { + "name": "Delete Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "1102cae1-9db3-4dc4-b7bb-ca6b2bef50fb", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "414f49b0-6941-4b6d-a9ab-8a788e817638", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57a9b5cf-ff36-409a-9dc0-e017af84d705", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17f43803-0ebb-413a-9e42-903a74e4c2df", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cd339b0-9c0d-4e30-bcaa-f3ed13d02878", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dcb7dacc-25ca-458c-958b-241acf76fb11", + "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": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "294aa6ab-3de5-41d8-8906-64921a0060e6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "entitlements", + "description": "", + "item": [ + { + "id": "c35343f4-d907-471f-b6fc-0f33c7ea6aaf", + "name": "Account Entitlements", + "request": { + "name": "Account Entitlements", + "description": { + "content": "This API returns entitlements of the account. \nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d4a23898-3673-4fc9-ace2-c462de8e0f43", + "name": "An array of account entitlements", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"attributes\": {\n \"deserunt76\": 10834438.787528232\n },\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"source\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"attributes\": {\n \"utf\": true,\n \"anim_1\": 80325408.52808392,\n \"cillum_33\": \"sunt enim eiusmod\"\n },\n \"sourceSchemaObjectType\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"source\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df6ea66c-58df-4694-b442-790b72a1bd15", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3916e54-1ec2-4b12-92e2-d7a00327e001", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57e15359-3e97-4036-b13f-d70079715166", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "09704c0c-b8f7-4d34-bbad-b5e87c5acfb3", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5331aa0f-8e91-4160-83ab-7cc2d6005098", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ca4ad23-ad87-4134-ad04-a2463ee956f2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reload", + "description": "", + "item": [ + { + "id": "5dabf42c-3676-4f3e-8b1b-f7460df7c88d", + "name": "Reload Account", + "request": { + "name": "Reload Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "1467a986-31a5-4329-bbd6-05e2a7ebbd9a", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "468a4f67-fef7-4c08-91df-2c7529589cc5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "281b0853-fe47-49f9-99e2-a1a4f5004ce7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cac513bd-4d57-41e5-8e7e-9aa84f4b66e7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a85e6200-06c2-456d-808d-ebb1d7176464", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1faa98a6-5f46-41ec-a6c6-94ccd60eeac3", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "240d8782-b5e9-4e6f-a5a7-df5fc7759a55", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "reload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "enable", + "description": "", + "item": [ + { + "id": "6ada3e99-e953-4893-81c9-0f19ff205ef6", + "name": "Enable Account", + "request": { + "name": "Enable Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "32d6ff3a-9351-4896-9892-7667bc9b73b9", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "53b29788-6e92-4a42-a09c-62b247ec2de4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7bfc939d-1cfc-4d5e-8417-fb13a1f571e8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "456b923d-b79a-4c72-9e2c-9f416a013b64", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5e0c315b-0d86-47e0-a5c3-d64a1b23c6d0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e3833cad-fb05-4ff8-be0b-4ab116b610e6", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a0f126b3-1279-4bf7-8380-3da26645de7e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "enable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "disable", + "description": "", + "item": [ + { + "id": "dc15a829-6531-461d-a08e-b12593a053b7", + "name": "Disable Account", + "request": { + "name": "Disable Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2d6925fe-2c5a-454d-9427-8f0bb9048e0f", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96f8ea1f-59ab-4cbe-95fe-8e48c0b296f6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89859d1a-a29e-40f6-89ce-ab6e3fdc3406", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d152fb2-8346-404a-80be-eff1203d8406", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "601767fd-1fc0-4515-a285-1bf0b6487193", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "02c9ab85-3fac-40db-b3e7-28d955f86e84", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51c1d845-4ca6-46da-ad6b-c4fcb1c7f1e4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "disable" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "unlock", + "description": "", + "item": [ + { + "id": "7e32a670-8121-449c-8c7d-415f11f98b12", + "name": "Unlock Account", + "request": { + "name": "Unlock Account", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "fbe2ab19-0fd8-4854-b47d-1d57e0636384", + "name": "Async task details", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "343d65c3-ce88-48f8-9c80-7dbaedee5725", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36cd2c4d-7536-4eca-a281-673e42c0c7ed", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc1f84fc-49b2-4c58-ae08-df3f842f4d77", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "030b2d2f-0632-4278-a3fd-8fab1d3b8536", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "827e9349-0e21-4c5c-ad3a-76fea7ca1d93", + "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": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "633449b8-c080-423e-b774-539aea6a32aa", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "accounts", + ":id", + "unlock" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"externalVerificationId\": \"\",\n \"unlockIDNAccount\": \"\",\n \"forceProvisioning\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "account-activities", + "description": "", + "item": [ + { + "id": "6a0584ea-3c05-42ac-9e1a-0dbef6cdc4c4", + "name": "List Account Activities", + "request": { + "name": "List Account Activities", + "description": { + "content": "This gets a collection of account activities that satisfy the given query parameters.", + "type": "text/plain" + }, + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3bdf5c53-f78f-4b97-bb1b-eae20406559a", + "name": "List of account activities", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"INCOMPLETE\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"EXPIRED\",\n \"provisioningStatus\": \"RETRY\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"CREATE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"deserunt_1e\": \"\",\n \"temporf\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"EXPIRED\",\n \"provisioningStatus\": \"COMMITED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"DELETE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"aliquip_\": \"\",\n \"eiusmod916\": \"\",\n \"sunt_cf\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"VERIFYING\",\n \"clientMetadata\": {\n \"ut_48\": \"\",\n \"pariatur_956\": \"\",\n \"eiusmod_e\": \"\",\n \"fugiat7\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"FAILURE\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"provisioningStatus\": \"FINISHED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"MODIFY\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"culpa_fc\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"provisioningStatus\": \"PENDING\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"ENABLE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"magna_bf\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"COMPLETED\",\n \"clientMetadata\": {\n \"do_4\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11116bc8-273d-4c88-8fb1-191a366f4ebe", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0fe3117f-a3ca-4f02-8c97-f62f9dc06586", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98eb076e-0722-400d-9209-4246c453eaa8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35965d83-7e31-41cb-a444-5e8ad62e2132", + "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": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3eb04d2e-33ed-42ca-8c88-f91f1b6ceea6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "account-activities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.", + "type": "text/plain" + }, + "key": "requested-by", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*.", + "type": "text/plain" + }, + "key": "regarding-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "30263e36-adfb-4fc0-b8e0-f21c79d15712", + "name": "Get an Account Activity", + "request": { + "name": "Get an Account Activity", + "description": { + "content": "This gets a single account activity by its id.", + "type": "text/plain" + }, + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3a61eb42-a88e-4661-8883-ccd52e6ff73c", + "name": "An account activity object", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"completed\": \"\",\n \"completionStatus\": \"FAILURE\",\n \"type\": \"\",\n \"requesterIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"targetIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"errors\": [\n \"\",\n \"\"\n ],\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"CANCELED\",\n \"provisioningStatus\": \"FAILED\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"DISABLE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ROLE\"\n },\n \"clientMetadata\": {\n \"dolor356\": \"\",\n \"in__2\": \"\"\n },\n \"removeDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"requested\": \"\",\n \"approvalStatus\": \"EXPIRED\",\n \"provisioningStatus\": \"RETRY\",\n \"requesterComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"reviewerComment\": {\n \"commenterId\": \"\",\n \"commenterName\": \"\",\n \"body\": \"\",\n \"date\": \"\"\n },\n \"operation\": \"DISABLE\",\n \"attribute\": \"\",\n \"value\": \"\",\n \"nativeIdentity\": \"\",\n \"sourceId\": \"\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"\",\n \"requestedObjectName\": \"\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"reprehenderit2\": \"\",\n \"sunt5\": \"\"\n },\n \"removeDate\": \"\"\n }\n ],\n \"executionStatus\": \"TERMINATED\",\n \"clientMetadata\": {\n \"irure_c\": \"\",\n \"adipisicinga2\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "645dd3d0-5b74-48b6-90e6-0a6d3e31a54a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e7d95cc2-4800-46e1-87aa-6138708f8a95", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16fafc02-3c5f-44f4-a385-624261c416b9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dcd3c6b8-3d71-4ddd-ad61-0ccd99f2fb1e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a0cfcfa-9ce2-483e-954a-1d49fdec3feb", + "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": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "37f4131a-1a3c-46c3-9ddf-3f5e4df980b7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "account-activities", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "auth-org", + "description": "", + "item": [ + { + "name": "network-config", + "description": "", + "item": [ + { + "id": "a3233d01-fc2d-4a4e-b374-747011fc4d51", + "name": "Get security network configuration.", + "request": { + "name": "Get security network configuration.", + "description": { + "content": "This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "0bc13665-60e7-446a-aa2d-267f7ae4ef6a", + "name": "Network configuration for the tenant's auth org.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b7da488f-b62c-45ff-8c9d-50d4f0017b03", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c13673fb-d46c-4533-9bc1-0a7733d30d3b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "54ea3dc3-f91e-4b18-b92b-d590c7d9b98c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "25a85e33-ab50-4cf1-917e-2b0272b4cb1a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6426da3-9187-4ee2-9736-479b6401dd3d", + "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": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b10ccb5-ba9d-49db-a611-eb3a28e768e0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "950627f7-4fe0-46fe-b50b-09b1bcdeba14", + "name": "Create security network configuration.", + "request": { + "name": "Create security network configuration.", + "description": { + "content": "This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:create'", + "type": "text/plain" + }, + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "801ccd1d-7e31-49b9-b9c5-e9817ef5de65", + "name": "Network configuration for the tenant.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "185fe9e5-eeee-487f-bb03-3fae13313033", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "adc54c6b-21ea-492d-9828-a9a8d1ba2a25", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8825dd6a-717b-4367-849b-f3ea0cc28e2c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "87934969-542a-4a83-a612-5bef959d96cb", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20fbd66b-db05-4561-b2df-a11c0e21ea5e", + "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": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73e9aa04-d2ef-4044-88cc-7b80bf4bfa7e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a211ff96-deb6-4a94-9769-e673d5f2c3d3", + "name": "Update security network configuration.", + "request": { + "name": "Update security network configuration.", + "description": { + "content": "This API updates an existing network configuration for an org using PATCH\n Requires security scope of: 'sp:auth-org:update'", + "type": "text/plain" + }, + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3aa2a4b5-2586-47d2-af1f-a77798c4c85d", + "name": "Updated Auth Org network configuration.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"range\": [\n \"\",\n \"\"\n ],\n \"geolocation\": [\n \"\",\n \"\"\n ],\n \"whitelisted\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "869a1535-b177-46dc-839c-2e5a18733313", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e207e441-702b-4e69-a139-d429732ac6d1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "034ba402-da7c-4f63-b392-e914340e6738", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6aa5379-ae6e-4236-8453-bf4ffe4a2a67", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9282c4b1-0f84-4302-a299-ed166f24f140", + "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": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "52d3c19b-78cc-4be9-b191-366660f127df", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "auth-org", + "network-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "auth-users", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "fe378d0f-8617-4ada-9193-feceebb8fecb", + "name": "Auth User Details", + "request": { + "name": "Auth User Details", + "description": { + "content": "This API returns the specified user's authentication system details.\nRequires security scope of: 'sp:auth-user:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "2dc7087f-ede3-45c7-9583-2d4768ca8fbe", + "name": "The specified user's authentication system details.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"tenant\": \"\",\n \"id\": \"\",\n \"uid\": \"\",\n \"profile\": \"\",\n \"identificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"workPhone\": \"\",\n \"personalEmail\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"displayName\": \"\",\n \"alias\": \"\",\n \"lastPasswordChangeDate\": \"\",\n \"lastLoginTimestamp\": \"\",\n \"currentLoginTimestamp\": \"\",\n \"capabilities\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "77d4f14e-5f71-4839-86d5-c79222f2f89b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f3c74a1e-58c3-4ee2-9aaf-d4dd735a3e04", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb7a3db1-1d61-47c6-bf89-025f7b621085", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3643dcfd-fc4b-4459-95b0-3dd2bd24c99a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbc393eb-e622-4f69-a8e1-49679cf187ee", + "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": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "440f27d5-66a3-41ed-9e61-d9fab6cbc8fa", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d9baa075-cd7e-47ed-999e-c775e6d1c8f4", + "name": "Auth User Update", + "request": { + "name": "Auth User Update", + "description": { + "content": "Update an existing user in the authentication system with a PATCH request.", + "type": "text/plain" + }, + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3670620a-668e-492d-b9ca-731ec8d99d2d", + "name": "Auth user updated.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"tenant\": \"\",\n \"id\": \"\",\n \"uid\": \"\",\n \"profile\": \"\",\n \"identificationNumber\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"workPhone\": \"\",\n \"personalEmail\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"displayName\": \"\",\n \"alias\": \"\",\n \"lastPasswordChangeDate\": \"\",\n \"lastLoginTimestamp\": \"\",\n \"currentLoginTimestamp\": \"\",\n \"capabilities\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57af87c0-5141-413a-bf6d-57c32e478094", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e64566aa-cde4-46b1-b6f1-dff2f113ea4a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "858cb2e9-c783-4e2b-80d9-83f9e94857ad", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8618f334-3599-488c-a47d-9f0dfb467d13", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ffe7aa8-1060-4247-98a3-1f09ff577161", + "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": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2526ac0-2c08-4926-a0dd-2cc610d90f37", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "auth-users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "campaigns", + "description": "", + "item": [ + { + "id": "b7166ade-3895-4c4e-8824-5b739a1d2aa7", + "name": "List Campaigns", + "request": { + "name": "List Campaigns", + "description": { + "content": "Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "SLIM" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "15db8242-7176-4c6b-84f3-561e9a56fc41", + "name": "A list of campaign objects.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "SLIM" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SOURCE_OWNER\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"CANCELING\",\n \"correlatedStatus\": \"CORRELATED\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"PENDING\",\n \"correlatedStatus\": \"CORRELATED\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "572d4ed8-0394-4de4-b502-a9a76b8bd00b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "SLIM" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0eba603e-c53a-4f64-bfac-96e372cd680d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "SLIM" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ecc3803-0f74-4314-b64d-9e24688dc2f8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "SLIM" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef6a7f72-776d-4d1b-9435-d16ef552548f", + "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": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "SLIM" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c8ddc008-b246-49a7-ba0d-cd41f7fc30dc", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.", + "type": "text/plain" + }, + "key": "detail", + "value": "SLIM" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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, sw*\n\n**status**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **created**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ab3c1a24-38c6-4a19-9a7a-ac66692f5913", + "name": "Create a campaign", + "request": { + "name": "Create a campaign", + "description": { + "content": "Creates a new Certification Campaign with the information provided in the request body.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "165972a4-b9b7-457f-bc3f-983293526bc0", + "name": "Indicates that the campaign requested was successfully created and returns its representation.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "897014ff-635d-4323-a1b5-cc401a0003dc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1713af3-c1f7-4c30-be8e-66b718f646d7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57d27d11-b357-4b7d-b95c-ba62a9a27838", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "08a61729-1af4-4d9e-beb2-1f0b29ed25a9", + "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": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5eae7a06-da6e-4ddd-a8a1-41337068dd4e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"COMPLETED\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"created\": \"\",\n \"modified\": \"\",\n \"filter\": {\n \"id\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"\",\n \"reviewer\": {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"query\": \"\",\n \"identityIds\": [\n \"\",\n \"\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"operator\": \"SELECTED\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"ROLE\",\n \"operator\": \"ALL\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reviewer\": {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"roleIds\": [\n \"\",\n \"\"\n ],\n \"query\": \"\",\n \"description\": \"\"\n },\n \"alerts\": [\n {\n \"level\": \"INFO\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"totalCertifications\": \"\",\n \"completedCertifications\": \"\",\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"SOURCE\",\n \"name\": \"\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "5c23a9b4-10e9-4929-8a4d-1c6026bb09db", + "name": "Get a campaign", + "request": { + "name": "Get a campaign", + "description": { + "content": "Retrieves information for an existing campaign using the campaign's ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "cb526245-4054-4a50-ad5e-ef80fb5f87c7", + "name": "A campaign object", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ERROR\",\n \"correlatedStatus\": \"CORRELATED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e63e2025-f0ef-4be1-9260-4269a30dca81", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af48e27e-a89b-4540-a06d-1ab01ba09d4a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30c97cc6-445f-4bd2-9a64-95d8302fcac1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7239e1ae-c34f-48dd-a549-13c7ba4ec6a4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2bbe7c9-3bbb-484f-8de9-346d998ce267", + "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": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecb2f682-342e-417a-8a8b-e5164ca81b7d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "78932f51-b0de-4aa7-94cf-6f59b2666513", + "name": "Update a Campaign", + "request": { + "name": "Update a Campaign", + "description": { + "content": "Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "5193f338-88b0-45d0-be71-ffa38014819b", + "name": "Indicates the PATCH operation succeeded, and returns the campaign's new representation.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"SEARCH\",\n \"id\": \"\",\n \"deadline\": \"\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"status\": \"ERROR\",\n \"correlatedStatus\": \"CORRELATED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef75c58a-fdd0-47e6-9fb5-e22d01b567cb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1288f899-af53-41a8-9d6b-d0d02f34e10f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f4a4774-5119-42f6-901b-ae7290a8f356", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "83f4818d-f56c-46d3-aaf3-695522c12ef3", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e76e878-b40d-4d1e-9906-a65f45a64667", + "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": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a3449027-520e-489e-a76c-4c82fb5fa815", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "reassign", + "description": "", + "item": [ + { + "id": "bb671629-41be-4c9a-992b-5459d4ef8ef9", + "name": "Reassign Certifications", + "request": { + "name": "Reassign Certifications", + "description": { + "content": "This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c25d4e3a-1847-4c71-b9df-0275b1972f97", + "name": "The reassign task that has been submitted.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"ADMIN_REASSIGN\",\n \"targetType\": \"CERTIFICATION\",\n \"targetId\": \"\",\n \"status\": \"ERROR\",\n \"errors\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"reassignmentTrailDTOs\": [\n {\n \"previousOwner\": \"\",\n \"newOwner\": \"\",\n \"reassignmentType\": \"\"\n },\n {\n \"previousOwner\": \"\",\n \"newOwner\": \"\",\n \"reassignmentType\": \"\"\n }\n ],\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b451b2bf-4e86-43b8-b4e6-a773c8d61351", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bea88f61-6452-49e1-8b06-c1f475f7c2ce", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff158a91-74fd-4cba-b9f7-5043d129d881", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ac151c8d-1b4c-4bf6-b7ad-f6acd3322463", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6d75ebd8-9c2e-4278-9fbf-08e626619d21", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1f5e292-6ad0-4960-9f5b-cde094833878", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"certificationIds\": [\n \"\"\n ],\n \"reassignTo\": {\n \"id\": \"\",\n \"type\": \"IDENTITY\"\n },\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "activate", + "description": "", + "item": [ + { + "id": "0a62b6b3-7eb0-4068-af1b-5df3a0801061", + "name": "Activate a Campaign", + "request": { + "name": "Activate a Campaign", + "description": { + "content": "Submits a job to activate the campaign with the given Id. The campaign must be staged.\nRequires roles of CERT_ADMIN and ORG_ADMIN", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "484c2a9a-636f-431e-a3aa-00d762ec207b", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d055b8c4-60e1-4be3-a5a5-afdf376a2057", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "44d5319a-8b5a-420f-b228-1190eb2626e1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bd7de3bb-d53b-4995-b735-7dc506076c52", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f2be635b-9c56-487f-9e62-c0cb835d82ee", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "92591bd4-5ce4-457c-90aa-f25a5708a56c", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0cbbbd19-68b4-44db-8aaa-8a16659fd43b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "activate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"timeZone\": \"Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "complete", + "description": "", + "item": [ + { + "id": "c978df7c-d474-4f28-9d84-308e778fb302", + "name": "Complete a Campaign", + "request": { + "name": "Complete a Campaign", + "description": { + "content": ":::caution\n\nThis endpoint will run successfully for any campaigns that are **past due**.\n\nThis endpoint will return a content error if the campaign is **not past due**.\n\n:::\n\nCompletes a certification campaign. This is provided to admins so that they\ncan complete a certification even if all items have not been completed.\n\nRequires roles of CERT_ADMIN and ORG_ADMIN\n", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1cadb619-b248-4ab5-b2d4-a0d01f82aac4", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f00093ec-eb14-490b-b4d2-633e59528cfd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af0c34e6-d9f3-4b08-b9fe-b3bb8dbdc137", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a894699-7532-4871-9f3e-8ff6660e16b9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "29f6d24b-4b68-42b4-b654-134210bf3535", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7a398112-50e5-4e04-8b9d-b1eb22879693", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99f8a153-f805-4493-b155-3c8b4e177b48", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "complete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"autoCompleteAction\": \"APPROVE\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reports", + "description": "", + "item": [ + { + "id": "b8e53c66-a217-4aaa-8d56-7d8a8dbb3c74", + "name": "Get Campaign Reports", + "request": { + "name": "Get Campaign Reports", + "description": { + "content": "Fetches all reports for a certification campaign by campaign ID.\nRequires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "key": "id" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the campaign for which reports are being fetched.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "campaignId" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "07e20071-d6d6-40b1-ada7-46facd1f9411", + "name": "Array of campaign report objects.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"reportType\": \"CAMPAIGN_COMPOSITION_REPORT\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PENDING\",\n \"lastRunAt\": \"\"\n },\n {\n \"reportType\": \"CAMPAIGN_COMPOSITION_REPORT\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"TEMP_ERROR\",\n \"lastRunAt\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d60a649a-570e-49b3-acf3-a246feac6662", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5c79e22a-148b-4b70-b003-65f7bad6b06f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cde8c023-a7b9-433c-8d33-73f7ff21c5f6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bb82e56-539f-478d-94df-1d818e4ea07a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d806dfd-f485-4498-b830-eed3f2b09040", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a9a24e3-627a-4fe3-a1bc-40228136d593", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "reports" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "run-report", + "description": "", + "item": [ + { + "name": "{type}", + "description": "", + "item": [ + { + "id": "c48663be-844f-4b79-9383-984e74a4716e", + "name": "Run Campaign Report", + "request": { + "name": "Run Campaign Report", + "description": { + "content": "Runs a report for a certification campaign.\nRequires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "CAMPAIGN_STATUS_REPORT", + "key": "type", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "023456f9-1ef5-424a-9a6e-c2e3fe748296", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6b56d193-8ac0-437f-b7b5-0658d870a237", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51bf2a02-83ef-4513-8403-1a6cc1598b40", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9b69a5aa-c64e-4c01-b6ec-011175710d31", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f1c21a64-2d0a-4258-abe0-43281b86bee8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1786cfdf-4884-4593-a0db-7f6d668fbf9d", + "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": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab57e1f9-de4c-482d-b41d-6b9d30bf286e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + ":id", + "run-report", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "delete", + "description": "", + "item": [ + { + "id": "d38cbe11-1d5a-40a6-bcb3-de0101224022", + "name": "Deletes Campaigns", + "request": { + "name": "Deletes Campaigns", + "description": { + "content": "Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "caa2a190-cea6-4db5-9f52-77a1582ce1f2", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fcf57080-541c-4133-a634-732944c85ee5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f70086c-ed09-4b53-828a-41649ee9d764", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d400d09f-9e0f-4359-9575-ea940449169b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f812e67-079a-418b-b00e-444b4fac1593", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a097a8b7-1d87-4e9e-8bc0-da5357630bb9", + "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": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8408d885-1ee1-4a91-9dca-fc4ba5e47db4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "campaigns", + "delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "certifications", + "description": "", + "item": [ + { + "id": "4163ab05-9812-4e8a-8a0c-a840c2c012f8", + "name": "Identity Campaign Certifications by IDs", + "request": { + "name": "Identity Campaign Certifications by IDs", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The ID of reviewer identity. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "reviewer-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ea5078e9-d24a-450e-85cc-36356b572d66", + "name": "List of identity campaign certifications", + "originalRequest": { + "url": { + "path": [ + "certifications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The ID of reviewer identity. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "reviewer-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"SOURCE_OWNER\",\n \"description\": \"\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"ALL_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"STAGED\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"SOURCE_OWNER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"SIGNED\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5a44be55-9c6b-44d1-9171-35d540ee9e63", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The ID of reviewer identity. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "reviewer-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "edad67ac-f856-4469-9f25-73b98e718867", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The ID of reviewer identity. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "reviewer-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "456f1086-3351-4841-8a1a-1877a2fd6d30", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The ID of reviewer identity. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "reviewer-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34d58e8b-13c7-446a-b94c-f1165f21fca4", + "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": { + "url": { + "path": [ + "certifications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The ID of reviewer identity. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "reviewer-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea748c4f-e6af-4528-8ced-8f37099068b3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The ID of reviewer identity. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "reviewer-identity", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "9d4e35de-3a88-42be-bbec-6d5760f4fefc", + "name": "Identity Certification by ID", + "request": { + "name": "Identity Certification by ID", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "b1375519-8367-4979-bddf-8fb34af97750", + "name": "An identity campaign certification object", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"STAGED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20308b1c-a7f9-48b8-b33d-b4c7b1b8f4e3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eccae90d-20b2-4b64-b318-aa24eb780cd3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "54b53213-2432-40af-b125-b06be531d6c1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed96b5bc-46ab-475e-b483-3d320d93d660", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b522c2d2-c49d-4d29-98a6-c6026d9121f4", + "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": { + "url": { + "path": [ + "certifications", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "82db144a-32ff-4ca2-82c1-38c80d7ce519", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "access-review-items", + "description": "", + "item": [ + { + "id": "1a6c7cb8-2649-4814-bc9d-80a0c055de8d", + "name": "List of Access Review Items", + "request": { + "name": "List of Access Review Items", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "access-review-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "entitlements", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "access-profiles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "84cd278f-2a71-4565-92e5-a859a87503c6", + "name": "A list of access review items", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-review-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "entitlements", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "access-profiles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"accessSummary\": {\n \"access\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"id\": \"\",\n \"completed\": \"\",\n \"newAccess\": \"\",\n \"decision\": \"APPROVE\",\n \"comments\": \"\"\n },\n {\n \"accessSummary\": {\n \"access\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TAG_CATEGORY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n \"id\": \"\",\n \"completed\": \"\",\n \"newAccess\": \"\",\n \"decision\": \"REVOKE\",\n \"comments\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b7a7605-9913-47a8-91bf-ca8f0244f412", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-review-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "entitlements", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "access-profiles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e30c0c5-e1a5-4a04-9a03-f5f73ccb5fba", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-review-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "entitlements", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "access-profiles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38305463-2cee-47a2-af9d-a18e6a6a45c1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-review-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "entitlements", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "access-profiles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d80f723-c4b2-45b4-86d8-4a30f3b563fc", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-review-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "entitlements", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "access-profiles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1b8e7804-be5c-49dc-a97e-28f42ee5fb6a", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "access-review-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "entitlements", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "access-profiles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4c7d05f6-b695-4e37-b224-af26e7f948f2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-review-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "entitlements", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "access-profiles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "decide", + "description": "", + "item": [ + { + "id": "9301faa0-7dfd-4255-8d4e-344fd239fa30", + "name": "Decide on a Certification Item", + "request": { + "name": "Decide on a Certification Item", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "decide" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "222eb8c5-644d-49b6-8002-5131dba37dd6", + "name": "An identity campaign certification object", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decide" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"STAGED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3d63b9a4-87c1-41e5-8e83-59b62eeceb24", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decide" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a9e969d-40a7-4abb-bd6e-8a1746cdd5d3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decide" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c43d540-308a-4deb-ba6e-4cdcd871c2c6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decide" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9af927d2-b721-4f81-8402-377e1304d4ec", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decide" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "50fba813-e67b-4765-9d8b-cce4bf632457", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "decide" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bd78bc48-6f07-47d6-89ff-40ebf2d8593c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decide" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"id\": \"\",\n \"decision\": \"REVOKE\",\n \"bulk\": \"\",\n \"proposedEndDate\": \"\",\n \"recommendation\": {\n \"recommendation\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n },\n \"comments\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reassign", + "description": "", + "item": [ + { + "id": "dc307bab-bb58-4f10-aed8-036275859956", + "name": "Reassign Identities or Items", + "request": { + "name": "Reassign Identities or Items", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"TARGET_SUMMARY\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4cd8a67e-f837-40f3-bc74-4db22f3ec32a", + "name": "An identity campaign certification details after completing the reassignment.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"TARGET_SUMMARY\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"STAGED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "952cb9a4-b973-48d9-8c14-2aec68bac179", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"TARGET_SUMMARY\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4388ff2b-328b-4910-a540-4e88cf0dafa0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"TARGET_SUMMARY\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "305d451c-f079-4de0-8240-e274c99ea616", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"TARGET_SUMMARY\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "364174ae-4cb1-426c-a3d8-076731576476", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"TARGET_SUMMARY\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5e15bf3-eb69-425d-ae96-31e27ac0b005", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"TARGET_SUMMARY\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6e94618d-dbca-4e10-b20a-779d4cc1b373", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "reassign" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"reassign\": [\n {\n \"id\": \"\",\n \"type\": \"ITEM\"\n },\n {\n \"id\": \"\",\n \"type\": \"TARGET_SUMMARY\"\n }\n ],\n \"reassignTo\": \"\",\n \"reason\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "sign-off", + "description": "", + "item": [ + { + "id": "c118f87c-1548-434d-97d9-cd72145b36e2", + "name": "Finalize Identity Certification Decisions", + "request": { + "name": "Finalize Identity Certification Decisions", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "sign-off" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "f837b12e-9f17-4d69-92bf-d881adb76414", + "name": "An identity campaign certification object", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "sign-off" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"\",\n \"correlatedStatus\": \"UNCORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": \"\",\n \"identitiesCompleted\": \"\",\n \"identitiesTotal\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"decisionsMade\": \"\",\n \"decisionsTotal\": \"\",\n \"due\": \"\",\n \"signed\": \"\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"IDENTITY\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"comment\": \"\"\n },\n \"hasErrors\": \"\",\n \"errorMessage\": \"\",\n \"phase\": \"STAGED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f4387c6-c1ea-4d1a-bb6e-a9c3a3d8e827", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "sign-off" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9fbee276-ac67-4b70-bfcf-0d4380dd731c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "sign-off" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c92036d5-c53e-41db-a485-c7114acfb64d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "sign-off" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e334d95-cba0-46d7-bce4-e3daf9c964d4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "sign-off" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2128cf02-318b-4bff-82ec-cc172aad466e", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "sign-off" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9485b583-7705-4872-afe2-c40539b11fc0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "sign-off" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "decision-summary", + "description": "", + "item": [ + { + "id": "5882cf68-768e-4737-a75d-3f723f4615ba", + "name": "Summary of Certification Decisions", + "request": { + "name": "Summary of Certification Decisions", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "decision-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**identitySummary.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "2313e087-a791-42f3-a1af-c8228654cd20", + "name": "Summary of the decisions made", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decision-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**identitySummary.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"entitlementDecisionsMade\": \"\",\n \"accessProfileDecisionsMade\": \"\",\n \"roleDecisionsMade\": \"\",\n \"accountDecisionsMade\": \"\",\n \"entitlementDecisionsTotal\": \"\",\n \"accessProfileDecisionsTotal\": \"\",\n \"roleDecisionsTotal\": \"\",\n \"accountDecisionsTotal\": \"\",\n \"entitlementsApproved\": \"\",\n \"entitlementsRevoked\": \"\",\n \"accessProfilesApproved\": \"\",\n \"accessProfilesRevoked\": \"\",\n \"rolesApproved\": \"\",\n \"rolesRevoked\": \"\",\n \"accountsApproved\": \"\",\n \"accountsRevoked\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ff5962e-ed11-4dc4-94f5-b8440e1f68fe", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decision-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**identitySummary.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6dca6659-aea9-428b-a6a9-13c219fde73c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decision-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**identitySummary.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e54ec750-9079-4c7f-ab12-53375dad06a4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decision-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**identitySummary.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "50148760-5065-4cc6-9766-5188a171fa24", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decision-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**identitySummary.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd670bce-c122-42bd-8494-ea979c446d08", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "decision-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**identitySummary.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6552df6d-4961-4583-a314-cada0a845c01", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "decision-summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**identitySummary.id**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "identity-summaries", + "description": "", + "item": [ + { + "id": "ad7f6be0-cd05-49e8-b387-274f382492c4", + "name": "Identity Summaries for Campaign Certification", + "request": { + "name": "Identity Summaries for Campaign Certification", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "54be0ac8-46d4-4287-815e-3438eb06c3cc", + "name": "List of identity summaries", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9f3b9464-9ce8-40b4-b5e3-e245370605af", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e04731d-caa1-431b-a82e-1f27fcd7f9b3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "658c3935-bd8c-4918-9d3c-283934fd74b6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b23135a9-379e-416a-8e42-d7f59ff14167", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e459d7c2-db5f-4d7a-a940-794f7089a05e", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e23aa21-b890-4bbb-83cf-1e861293496f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{identitySummaryId}", + "description": "", + "item": [ + { + "id": "f1845974-bfa5-48a7-8f22-dd325074f7ea", + "name": "Summary for Identity", + "request": { + "name": "Summary for Identity", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries", + ":identitySummaryId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "identitySummaryId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3f97873a-064f-4251-9546-ebbe8b0aaf07", + "name": "An identity summary", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries", + ":identitySummaryId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"identityId\": \"\",\n \"completed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b296a6c3-2f56-429f-9bfe-a403f6658ffc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries", + ":identitySummaryId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "898d04a2-9464-480d-a7fe-394663de87ca", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries", + ":identitySummaryId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ba3032a-9d7b-4fa9-8b01-9002a3aed357", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries", + ":identitySummaryId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1ddd739e-ce30-41c9-b328-1e9cf1db4f65", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries", + ":identitySummaryId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "80beefbc-091c-4e52-8d68-88c3b56123c6", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries", + ":identitySummaryId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "76d4ef23-88cd-46d1-9560-3fe7179385fd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "identity-summaries", + ":identitySummaryId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "access-summaries", + "description": "", + "item": [ + { + "name": "{type}", + "description": "", + "item": [ + { + "id": "f7e99ee9-85be-4215-88ac-be2277df2ee0", + "name": "Access Summaries", + "request": { + "name": "Access Summaries", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "certifications", + ":id", + "access-summaries", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "ROLE", + "key": "type", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4524749f-612d-4435-9d23-c49c86bb16a6", + "name": "List of access summaries", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-summaries", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"access\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"REPORT_RESULT\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n },\n {\n \"access\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlement\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n \"accessProfile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"revocable\": \"\",\n \"endDate\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"cloudGoverned\": \"\",\n \"endDate\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"privileged\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"attributeName\": \"\",\n \"attributeValue\": \"\",\n \"sourceSchemaObjectType\": \"\",\n \"sourceName\": \"\",\n \"sourceType\": \"\",\n \"hasPermissions\": \"\",\n \"isPermission\": \"\",\n \"revocable\": \"\",\n \"cloudGoverned\": \"\",\n \"account\": {\n \"nativeIdentity\": \"\",\n \"disabled\": \"\",\n \"locked\": \"\",\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n }\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n ]\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0bb7437-52df-498b-9882-e287cf2f2e73", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-summaries", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99798827-cd01-4470-9c2d-63f5c28cd30b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-summaries", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca2bcedf-6fdf-4747-a08c-8a43bf87f601", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-summaries", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d76fb86-147e-4100-a4da-f2eda7a2219d", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-summaries", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f65ad801-1486-42ef-9d3c-0fa14cf129b9", + "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": { + "url": { + "path": [ + "certifications", + ":id", + "access-summaries", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7cc270ed-159b-43bb-9276-a9c0ddc8c353", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "certifications", + ":id", + "access-summaries", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "identities", + "description": "", + "item": [ + { + "name": "{identity-id}", + "description": "", + "item": [ + { + "name": "set-lifecycle-state", + "description": "", + "item": [ + { + "id": "28ea9b61-9113-4b77-9072-3bdaf4b2de23", + "name": "Set Lifecycle State", + "request": { + "name": "Set Lifecycle State", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "identities", + ":identity-id", + "set-lifecycle-state" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"lifecycleStateId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2234dd77-4d22-4052-b452-aff4e19852b1", + "name": "The request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identity-id", + "set-lifecycle-state" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"lifecycleStateId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"accountActivityId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d0debf33-c3dd-4c2f-84c3-6476d1335402", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identity-id", + "set-lifecycle-state" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"lifecycleStateId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecf8ae13-7f14-464c-a87a-a6b139c8aaf7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identity-id", + "set-lifecycle-state" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"lifecycleStateId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98ef5580-da4b-470e-93cf-bf46ff35792b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identity-id", + "set-lifecycle-state" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"lifecycleStateId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e873c52-a872-4dd3-955e-52ffff9332e4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identity-id", + "set-lifecycle-state" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"lifecycleStateId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef47834b-08d3-496d-b113-dd9494d436d9", + "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": { + "url": { + "path": [ + "identities", + ":identity-id", + "set-lifecycle-state" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"lifecycleStateId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6748413f-720f-4a0c-b0bc-fcb8056bd34f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identities", + ":identity-id", + "set-lifecycle-state" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"lifecycleStateId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "identity-profiles", + "description": "", + "item": [ + { + "name": "{identity-profile-id}", + "description": "", + "item": [ + { + "name": "lifecycle-states", + "description": "", + "item": [ + { + "id": "0fd91055-1dda-4ebb-baf1-b18426ca9b41", + "name": "Lists LifecycleStates", + "request": { + "name": "Lists LifecycleStates", + "description": { + "content": "This end-point lists all the LifecycleStates associated with IdentityProfiles.\nA token with API, or ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "fbdd5f71-2ebf-4ff8-8507-ed33caf6a3bc", + "name": "List of LifecycleState objects", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "323a68f8-595d-44c3-b550-f011e91c93cc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bb868336-85da-4c52-9d03-2df5fa07e597", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3b963f4a-c352-4dfc-adef-8b17ad93e7f6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01262c3e-6c51-4096-a9c6-3a3e6e7e2193", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cdaf55e6-5f5f-4536-a309-e046676d7be2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "60579478-c63f-489d-bf49-bf6a2ff54442", + "name": "Create Lifecycle State", + "request": { + "name": "Create Lifecycle State", + "description": { + "content": "This API creates a new Lifecycle State.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6bf7537f-f243-42f5-8d2a-12cb997cad1a", + "name": "Created LifecycleState object.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01868d80-3971-4eb3-bb1b-eea3fdfa9f72", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13f7c306-8bbb-4fa3-ba8e-7635e337f3d7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e422aad2-6a07-4421-99ce-9ce3f26eaa56", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dfba077d-d8e8-44b9-8398-8cc23f01914e", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa4abcfd-1073-4e1a-b5e3-df465d7bb060", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{lifecycle-state-id}", + "description": "", + "item": [ + { + "id": "2f80ddab-5363-4d52-ba66-51ce64facc2c", + "name": "Retrieves Lifecycle State", + "request": { + "name": "Retrieves Lifecycle State", + "description": { + "content": "This endpoint retrieves a Lifecycle State.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "lifecycle-state-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1540acb9-67e7-45f3-8917-6602d44bf732", + "name": "The requested LifecycleState was successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb55fda0-6f4e-4ff9-af3e-1332982b5be0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4b57cc2-09ea-46aa-98c1-b69b28c171c5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "197663df-dc3a-418b-abf5-1182152db0c5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13c6a60f-6220-468e-870e-d2fa6d33909f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48f7ff88-13d2-4400-b2b3-c0b418efce8b", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "28b8f47c-d7f7-4039-9fb1-25f2d81d5229", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "259cc8f0-c84b-4f9f-a0de-74ae7a0dd89e", + "name": "Update Lifecycle State", + "request": { + "name": "Update Lifecycle State", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "lifecycle-state-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6b25515c-1cdf-4cbd-a303-601de7d153e2", + "name": "The LifecycleState was successfully updated.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"technicalName\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": \"\",\n \"description\": \"\",\n \"identityCount\": \"\",\n \"emailNotificationOption\": {\n \"notifyManagers\": \"\",\n \"notifyAllAdmins\": \"\",\n \"notifySpecificUsers\": \"\",\n \"emailAddressList\": [\n \"\",\n \"\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"DISABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "68c9893b-5a0e-4ea4-8f44-88a0829cc6d4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "802cbd75-4979-462c-baa0-b8c68de97b14", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e335fc5f-f3a1-4c51-a06e-150b1d9071c0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5989b223-7672-4091-9d05-0155ec039a1a", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36ed6b40-9c5c-4aec-b8a8-0ab833d9cbb0", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ad0ade78-b7e6-46ea-bbe3-9dacb3abf72e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2fc2ac33-f97a-46c5-8d81-6d1cec78c440", + "name": "Delete Lifecycle State by ID", + "request": { + "name": "Delete Lifecycle State by ID", + "description": { + "content": "This endpoint deletes the Lifecycle State using it's ID.\nA token with API, or ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "lifecycle-state-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "651bb289-8d6e-4cc5-8c99-e88f4c84a5b3", + "name": "The request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0bddd0b-1cae-4ac8-8e47-c208a4700c10", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d74032c8-b1b9-4245-9582-0ad46af911b1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8460f055-17f8-49fa-b7d2-3f1fb23eb16b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5ccf9f86-d2be-4469-bc0d-2945cc0796b6", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "79db243d-bba7-44aa-8b53-acba408e2dfb", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c749b5d-8533-413c-ae24-c1bcb0aa5dbe", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "lifecycle-states", + ":lifecycle-state-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "id": "2dd1594d-cb2c-45bf-b979-78c741dbdede", + "name": "Get single Identity Profile", + "request": { + "name": "Get single Identity Profile", + "description": { + "content": "This returns a single Identity Profile based on ID.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9e019686-c1e4-493b-8d17-f1385b11271e", + "name": "An Identity Profile object.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"officia73\": \"\",\n \"magna_5_\": \"\",\n \"commodo_f\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"qui_f0\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12f3600f-76bd-4342-9d43-b3b704d07a37", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "041258aa-71c7-4a67-9cef-e436467fa4a6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5c2d7b13-7d61-4179-8604-f41fafd685fc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "470f17c2-b49b-4b3b-abb2-dbc733692867", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b29798d3-dfb2-4ebc-ba3c-9335a95adab2", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42c20719-9604-408c-960f-7acf1fb7d134", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "504c099f-ffe9-41fa-bf14-6c8e3d562c30", + "name": "Delete an Identity Profile", + "request": { + "name": "Delete an Identity Profile", + "description": { + "content": "This deletes an Identity Profile based on ID.\n\nOn success, this endpoint will return a reference to the bulk delete task result.\n\nA token with ORG_ADMIN authority is required to call this API.\n\nThe following rights are required to access this endpoint: idn:identity-profile:delete", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "9e684e04-5d30-4c8c-ba81-3eecd684ef71", + "name": "Accepted - Returns a TaskResult object referencing the bulk delete job created.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"launcher\": \"\",\n \"completed\": \"\",\n \"launched\": \"\",\n \"completionStatus\": \"TempError\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf000665-ba0a-499b-8aae-1a3b7649a823", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aedcb462-1267-4fc0-813f-206c0e6908a9", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "daa60ba7-daae-4e8d-8fbe-931ea68426d8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "989ea83a-d7b4-4875-9ca8-313024cba7e8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2bc31f82-070f-4d79-9d0a-0a4f0466389b", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db5231f5-9ff7-4199-b53c-f37668a0661f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "default-identity-attribute-config", + "description": "", + "item": [ + { + "id": "537ce3b4-693f-413b-9b11-be97d60427ef", + "name": "Get default Identity Attribute Config", + "request": { + "name": "Get default Identity Attribute Config", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ccb53d01-371c-4e97-aae6-d7138bcd6064", + "name": "An Identity Attribute Config object.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"culpa96\": \"\",\n \"magna60\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"ut95\": \"\"\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf036fb5-d3ea-4c3f-a50b-d06e7f6b9e11", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6de5b826-dce1-4056-a8e8-aaece42b3eeb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97fb12a6-1d20-4272-a58e-57ff5a551583", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "552289e8-9210-4e33-ae96-fc4f864c3430", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b15e699-ff0a-48cf-9cee-f78195877963", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "566a630e-0767-4a5a-ab70-32610ae10538", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "default-identity-attribute-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "process-identities", + "description": "", + "item": [ + { + "id": "29d20460-5925-45fd-92aa-9b588b043dab", + "name": "Process identities under profile", + "request": { + "name": "Process identities under profile", + "description": { + "content": "Process identities under the profile\n\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "identity-profile-id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "b8b24c0e-bed7-4a1b-9a22-53af5bcad823", + "name": "Accepted status after refresh has launched", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "83d69ece-d920-460a-9613-3237860e58fa", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35d449f6-744c-4bb7-a368-02e7b231d51f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0287376-3119-4db0-8a3d-e56befde6925", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49d518b7-3290-408f-bb97-6ac6d55e25b2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38a7b901-0f74-4340-af70-41e0b7a01055", + "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": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f61a8d5-acfb-4f62-90ce-0721e4a7c44e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + ":identity-profile-id", + "process-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "id": "fd3ea044-ea00-4ba1-bbbb-9733f2caef45", + "name": "Identity Profiles List", + "request": { + "name": "Identity Profiles List", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "8438fe62-08fe-44fe-86cf-93ed1bc4762f", + "name": "List of identityProfiles.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"aliquip7\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"eiusmod_d7\": \"\",\n \"eu69\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n },\n {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"ullamco_59\": \"\",\n \"Ut9b9\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"cillum__1\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ede9c049-6384-4539-8c51-bc36daf95601", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1c21d27a-4e8c-455a-b611-a5b3b372af74", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3b0ff116-4196-4311-92af-c15621bd9339", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d27721fd-b6ec-4e10-b1af-76b048b16618", + "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": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4eb7931c-9523-4ab1-922d-cd4fc044cb6f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "3ae5caa9-8534-429b-8e8c-d292978cc7cb", + "name": "Delete Identity Profiles", + "request": { + "name": "Delete Identity Profiles", + "description": { + "content": "This deletes multiple Identity Profiles via a list of supplied IDs.\n\nOn success, this endpoint will return a reference to the bulk delete task result.\n\nA token with ORG_ADMIN authority is required to call this API.\n\nThe following rights are required to access this endpoint: idn:identity-profile:delete", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8bd809d7-6efc-4af7-9f7b-8b7d06035fdc", + "name": "Accepted - Returns a TaskResult object referencing the bulk delete job created.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"launcher\": \"\",\n \"completed\": \"\",\n \"launched\": \"\",\n \"completionStatus\": \"Terminated\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e90714ed-6e75-4469-8cc4-7bb1468a2a2a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c12b36f-bdce-485f-b3f1-8f8b8880e697", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbd26568-eea4-4f7c-aa15-cadf047ea60e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "697f1e59-7514-4ec8-bf7a-79d21b4f1cfa", + "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": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "86a56a48-2eac-4716-9ec3-0c55b5bfc4d4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n \"\",\n \"\"\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "export", + "description": "", + "item": [ + { + "id": "504bb36a-e259-4d4f-b0c9-36581eeb03ce", + "name": "Export Identity Profiles", + "request": { + "name": "Export Identity Profiles", + "description": { + "content": "This exports existing identity profiles in the format specified by the sp-config service.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3545a646-9c62-423f-ae0e-d25b38f696fe", + "name": "List of export objects with identity profiles.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consectetur_e\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"dolorebb\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt_0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sed5c1\": \"\",\n \"amet_d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "83025e1d-7086-4b5d-af31-23c40d2ffa5d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "857f6904-d284-49e7-a845-233547f3df25", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "00a55b6b-b8d8-472b-ae73-1d5afbe007cd", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "570cb068-0c56-4490-995c-2e4a102be69b", + "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": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a4f1946-be2b-4fb4-82d1-a5437b2d60c7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "export" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "import", + "description": "", + "item": [ + { + "id": "fada0def-0d11-4f49-aad9-fa04610cf5bb", + "name": "Import Identity Profiles", + "request": { + "name": "Import Identity Profiles", + "description": { + "content": "This imports previously exported identity profiles.", + "type": "text/plain" + }, + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consectetur_e\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"dolorebb\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt_0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sed5c1\": \"\",\n \"amet_d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3a5f244f-39ad-400f-bbf3-0292f2a3c2ec", + "name": "The result of importing Identity Profiles.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consectetur_e\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"dolorebb\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt_0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sed5c1\": \"\",\n \"amet_d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"infos\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"laboris_6\": \"dolor tempor\"\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"do_ab0\": \"nostrud id\",\n \"esse_e\": -7777776.201467961\n }\n }\n ],\n \"warnings\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"sunt_9e\": -12442449,\n \"consectetura\": true,\n \"dolor45\": \"proident adipisicing labore\",\n \"et_b99\": \"dolor nostrud incididunt\"\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"Duis_8\": \"officia ipsum est nisi enim\"\n }\n }\n ],\n \"errors\": [\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"ullamco_78b\": \"sunt enim Ut amet exercitation\"\n }\n },\n {\n \"key\": \"\",\n \"text\": \"\",\n \"details\": {\n \"in_c2\": \"aliquip ipsum\",\n \"in_169\": 44147191,\n \"eud2\": false\n }\n }\n ],\n \"importedObjects\": [\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c64b4180-5f2f-4c47-8e45-88f43e9a29e6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consectetur_e\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"dolorebb\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt_0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sed5c1\": \"\",\n \"amet_d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "918e7657-f66f-4470-b17c-b9dcfc982587", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consectetur_e\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"dolorebb\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt_0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sed5c1\": \"\",\n \"amet_d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45f06fbe-b9c7-40a1-b53d-54545bd616de", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consectetur_e\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"dolorebb\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt_0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sed5c1\": \"\",\n \"amet_d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "697bf84f-a5e8-4246-a0fa-be71081115dd", + "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": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consectetur_e\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"dolorebb\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt_0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sed5c1\": \"\",\n \"amet_d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb7eb098-2746-4507-ac91-71b5220bf376", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "identity-profiles", + "import" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"consectetur_e\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"dolorebb\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n },\n {\n \"version\": \"\",\n \"self\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"object\": {\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"priority\": \"\",\n \"identityRefreshRequired\": false,\n \"identityCount\": \"\",\n \"identityAttributeConfig\": {\n \"enabled\": false,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"deserunt_0\": \"\"\n }\n }\n },\n {\n \"identityAttributeName\": \"\",\n \"transformDefinition\": {\n \"type\": \"\",\n \"attributes\": {\n \"sed5c1\": \"\",\n \"amet_d\": \"\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"\",\n \"reportName\": \"\"\n },\n \"hasTimeBasedAttr\": false\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "non-employee-records", + "description": "", + "item": [ + { + "id": "8dadd750-cdfe-4d37-bb4c-ad376c10f07c", + "name": "Create Non-Employee Record", + "request": { + "name": "Create Non-Employee Record", + "description": { + "content": "This request will create a non-employee record.\nRequires role context of `idn:nesr:create`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3969b9fd-3c7d-4730-89be-f99f0c3f6166", + "name": "Created non-employee record.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"dolor_8\": \"\",\n \"reprehenderit_210\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a140097-081c-4611-9bf0-59218ab8fdbf", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e3534e40-15f1-4c3a-a380-bd1e2fd95c2b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c454220e-733b-4e89-a02c-08a4896bf7fc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5cf398fe-7d92-41be-a0da-08fa92c93743", + "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": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17516f5f-6759-47a0-84de-1cfce3a510e2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "834abb40-5b03-48ff-8ccf-09bee6ce3927", + "name": "List Non-Employee Records", + "request": { + "name": "List Non-Employee Records", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "b16b4aab-a57d-41ab-ac78-8842b3b64688", + "name": "Non-Employee record objects", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"est_5b\": \"\",\n \"sed6a\": \"\",\n \"Duis6\": \"\",\n \"in9\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"aute2a6\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5cc9a5f5-6b2d-4af3-8c99-ab9f7e1d9ce9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6b86a0d7-319e-4170-a7ca-cc6b220edd45", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "216ea46c-cda1-43ea-8204-c6c8d9bf81d1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "973f9681-087d-41d9-aaa3-fb19c51c6a2f", + "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": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0ea7f4c-a71a-423e-8286-564121275ceb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "1c4ceb15-6796-47ec-987e-be97d5e4ae4f", + "name": "Get a Non-Employee Record", + "request": { + "name": "Get a Non-Employee Record", + "description": { + "content": "This gets a non-employee record.\nRequires role context of `idn:nesr:read`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "666a1610-358c-4747-90a0-0dc8101a8532", + "name": "Non-Employee record object", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"dolor_8\": \"\",\n \"reprehenderit_210\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b396627a-604d-4aed-8a7f-502ab58600e6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "528b9ba8-23df-4b9f-a949-aa3582fd386e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8aaa3a72-260b-4c49-a3df-786128ac4084", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ee54041f-c210-4653-b82c-edd918c2e22b", + "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": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16198273-0200-439f-a55a-91557d6491d6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "55b2edf8-18b0-4955-9b79-fcdaef4ae8db", + "name": "Update Non-Employee Record", + "request": { + "name": "Update Non-Employee Record", + "description": { + "content": "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\nupdate all available fields.\n 2. The user is owner of the source, in this case they can only update the\nend date.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b0ae3a82-ca79-4496-8f41-2fab9f0e4d01", + "name": "An updated non-employee record.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"dolor_8\": \"\",\n \"reprehenderit_210\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7bcdee3c-1641-4452-a7df-45e1b62a8084", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3edcf3a6-7771-4cb4-ac8e-b23eb9f14977", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3451284-a515-4a57-b37e-baa4389e944a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "215230fb-0c71-4b08-84bf-7ddaad720bce", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97282f0e-d2c9-44c8-a6ca-66ce357426ef", + "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": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c43abfdc-44e8-4d9f-9c12-a3a46e9dd6d2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "40005149-d697-4728-a566-6f836fa28adf", + "name": "Patch Non-Employee Record", + "request": { + "name": "Patch Non-Employee Record", + "description": { + "content": "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\nupdate all available fields.\n 2. The user is owner of the source, in this case they can only update the\nend date.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "02075534-1804-4f70-b2b8-c4e71597fa74", + "name": "A patched non-employee record.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"data\": {\n \"dolor_8\": \"\",\n \"reprehenderit_210\": \"\"\n },\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "353a5109-e63a-4d66-8edc-37af60b755cd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "663161b4-3091-4361-acd0-a3c191d21109", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4fcd89a2-77d6-4849-ad96-2d7e69bc9ce0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65c9f556-caf9-41df-abcc-6a072adc5cb5", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "07c1ee1d-19f0-4ed5-8d94-e6c8fa05be63", + "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": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d43bb82-94dc-4522-923c-4ed0d894a31a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "74afcc34-04b8-4ecd-9054-6ec0e37cda1f", + "name": "Delete Non-Employee Record", + "request": { + "name": "Delete Non-Employee Record", + "description": { + "content": "This request will delete a non-employee record.\nRequires role context of `idn:nesr:delete`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "3abb515a-b8f7-4d98-aeea-f7026db0e64c", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "3424ac94-c741-4e20-b6d9-d26e5edcaafd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "653100ef-3544-44c6-b834-985abdb132fc", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "464f47f6-94ac-4657-bdd4-cb936720f116", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63b528fe-bdd0-4fd4-bd3f-b8dbd05b0ee7", + "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": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11941e2c-fde0-4e1d-b991-85e6b73012c1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "bulk-delete", + "description": "", + "item": [ + { + "id": "ee9693d2-745e-448e-a9be-605985557053", + "name": "Delete Multiple Non-Employee Records", + "request": { + "name": "Delete Multiple Non-Employee Records", + "description": { + "content": "This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1d59823d-5aff-4a61-b41c-5cdfa7281b47", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "9999410a-47d8-4d04-8f77-7dea270305ca", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d869e2e8-c663-4dbb-acff-964290ac789f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b59cd801-4174-49c3-a471-a83fb6db4da6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df8301a0-4ded-4319-9ed5-e3a7406140a9", + "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": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4625459-74fc-4e27-a624-bd2702d356ae", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-records", + "bulk-delete" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "non-employee-requests", + "description": "", + "item": [ + { + "id": "2b2ea185-200c-4dde-a46f-e2b8cbc52098", + "name": "Create Non-Employee Request", + "request": { + "name": "Create Non-Employee Request", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ce4914aa-c418-4eba-9bab-88af4bc1f950", + "name": "Non-Employee request creation object", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"irure86b\": \"\",\n \"incididunt_f6c\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"PENDING\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9cba400d-9381-4a3d-9bb9-b727a0715bd6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1874bba-879e-45ac-be0a-cc9a729e3289", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "928b5ebd-06fa-4766-acc3-563e46e912c6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c7258f8-5855-41a6-8eff-d17f7d681735", + "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": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "15d87cd5-7267-4ee2-9536-2a374d2af1d3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"sourceId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"data\": {\n \"elit1\": \"\",\n \"proident_0_\": \"\",\n \"sint_c_\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "6a360a22-f627-4583-82fa-b029920d6f13", + "name": "List Non-Employee Requests", + "request": { + "name": "List Non-Employee Requests", + "description": { + "content": "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\nshe 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\nprovided 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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "db3a6b4b-7e94-423e-878b-da7b9be463fe", + "name": "List of non-employee request objects.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"ea_8ba\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"NOT_READY\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"in0\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"PENDING\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"APPROVED\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "92f0d0f8-bd2d-4563-856a-e2ad9a386575", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8eb5e490-8a04-4642-9b37-3e7514313c7a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae4ea1e7-d885-4340-9bff-f160245b14eb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e88256e-bb7a-4cdd-8ee0-82c66c7e457d", + "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": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0302170-f847-4718-a24f-3b465684ee32", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "8ffdbc3f-4633-43be-a19e-6e892110a2ac", + "name": "Get a Non-Employee Request", + "request": { + "name": "Get a Non-Employee Request", + "description": { + "content": "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\ncan get the non-employee request for any user.\n 2. The user must be the owner of the non-employee request.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "63433026-92ba-4f3b-adf8-2e8c28b12ea3", + "name": "Non-Employee request object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n },\n \"data\": {\n \"irure86b\": \"\",\n \"incididunt_f6c\": \"\"\n },\n \"approvalItems\": [\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n ],\n \"approvalStatus\": \"PENDING\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b287cfcd-581a-4565-9ca9-5ac33bbc57b4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "84f8543d-eb70-4477-8d44-cd7ac0479f00", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "acd08f7f-8a46-4fca-877a-19a8672501b8", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1dca2f5-de46-481c-8941-07edbedfbcaf", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d176c19b-ebcb-4064-815e-1699e07b9be0", + "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": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4cb9227a-ea4f-489b-bd8b-4f9a79e16c2b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4aa2074b-cc7e-4399-8198-646a5ae693a4", + "name": "Delete Non-Employee Request", + "request": { + "name": "Delete Non-Employee Request", + "description": { + "content": "This request will delete a non-employee request. \nRequires role context of `idn:nesr:delete`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "e96857b5-d0fe-4e6f-8d59-967976847651", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "22142f5a-6032-4c34-94f7-4059bcc97e2a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a21e74de-2496-4e47-a5ed-59d491e36079", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3290adda-07a0-4907-820f-912cd020049a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "678e7a50-0581-4858-a9fa-5b274473657d", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8531d933-9922-4fa8-aa82-649651b72bf7", + "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": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ddf21b82-ea35-499a-ab34-e0325fd44d28", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "summary", + "description": "", + "item": [ + { + "name": "{requested-for}", + "description": "", + "item": [ + { + "id": "a8dd2983-c95d-4354-ab94-0f76d47f04b1", + "name": "Get Summary of Non-Employee Requests", + "request": { + "name": "Get Summary of Non-Employee Requests", + "description": { + "content": "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\nshe 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\nprovided 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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "requested-for", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "85cbd65d-48d6-4761-909d-9a3bd9f697db", + "name": "Non-Employee request summary object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"approved\": \"\",\n \"rejected\": \"\",\n \"pending\": \"\",\n \"nonEmployeeCount\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "310028c7-5e09-47b9-bd13-4db883b92547", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96dd457e-0f62-479c-b3a8-4b542c91039e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49cfa7c6-6615-4fa4-939c-92e7f3e833eb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "225ad049-92c3-4ee3-881f-fbbd96a278b3", + "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": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3d5db647-771d-4a7c-aa09-fa73be145b1a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-requests", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "non-employee-sources", + "description": "", + "item": [ + { + "id": "43d8488d-5cb4-40cf-a059-3be9307e1306", + "name": "Create Non-Employee Source", + "request": { + "name": "Create Non-Employee Source", + "description": { + "content": "This request will create a non-employee source. Requires role context of `idn:nesr:create`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6530e17c-27be-4fa0-af8f-13379fe34fdc", + "name": "Created non-employee source.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"cloudExternalId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c67689d5-e084-470b-8b3e-af9f4db641c1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf4bab40-e57a-4145-9022-f99143f08334", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a13b200f-7357-4090-95d2-c28107613e8b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "84f25950-81be-4bc9-91ce-6089ad71a050", + "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": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cd7f1c91-9fb5-4ad7-bab5-7361bf536d5d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"owner\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"managementWorkgroup\": \"\",\n \"approvers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "24008de7-e912-42bd-8a8c-06334fc4c243", + "name": "List Non-Employee Sources", + "request": { + "name": "List Non-Employee Sources", + "description": { + "content": "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\nshe 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\nprovided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "cf59e050-d97d-4071-8b46-712281e008f4", + "name": "List of non-employee sources objects.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeCount\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4db1bdf-2dee-4f32-bfc9-cbb3f9c016f8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "115838e8-6601-4a6e-a570-9e96cb2c03c1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5f07d214-48b2-42f1-a170-751ed5d9dfc6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3abfb2b7-926e-427e-8235-4c1ba1ef834f", + "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": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63866b99-1248-4516-8b12-7fb098cd8770", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "(Required) The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The flag to determine whether return a non-employee count associate with source.", + "type": "text/plain" + }, + "key": "non-employee-count", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{sourceId}", + "description": "", + "item": [ + { + "id": "efe8522d-3a6f-40ac-9947-623d479f5a07", + "name": "Get a Non-Employee Source", + "request": { + "name": "Get a Non-Employee Source", + "description": { + "content": "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\nshe may request any source.\n 2. The current user is an account manager, in which case the user can only\nrequest sources that they own.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5181567c-3642-44a9-b2bf-cdac24878a02", + "name": "Non-Employee source object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb3f73f2-cfd5-47a7-826c-1f81f3b09977", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2079fce7-5942-4458-8f8f-dce1f5c2e0de", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "791d4056-6627-4273-b4f5-7132b561e687", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e7584d4e-11a9-440e-9545-c5a143164de5", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "912d8a28-b9cd-4b6b-bcfe-48977f850879", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f5c49bbc-1e49-4e15-a095-c255391480e8", + "name": "Patch a Non-Employee Source", + "request": { + "name": "Patch a Non-Employee Source", + "description": { + "content": "patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "31ad3f9e-ca1a-46f7-acd3-2426ba9c0215", + "name": "A patched non-employee source object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n ],\n \"modified\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb7465a8-aecd-46b7-a075-4e0d69b75ae9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f733c44e-3702-4395-bff9-e4735ae9438a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3a909c00-2d98-46fe-b9e2-3ae2615712d2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "be6d3d0d-8312-4561-b8c2-d23101c256c6", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9d1062b7-1135-4e02-b1bb-aa97d2ddf980", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "6fffa6d9-c582-4b45-939f-2cc0c2444c52", + "name": "Delete Non-Employee Source", + "request": { + "name": "Delete Non-Employee Source", + "description": { + "content": "This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "f2627d89-ebc7-4c56-959d-9af19d25ec21", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "f2a47705-fdde-4e8c-9950-5bebdcdd47aa", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "71fc6ab4-6e5c-4fee-a54f-2e52c19aed60", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "04640d68-10ca-494d-91b2-e1ff48e5b07c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "322ab1cf-5ec7-4e12-99b7-a31242da3cbd", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33aca588-e83d-4056-a3fe-db9b718307f4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "schema-attributes", + "description": "", + "item": [ + { + "id": "ef42b253-158f-4310-b540-98d994ed9cd1", + "name": "List Schema Attributes Non-Employee Source", + "request": { + "name": "List Schema Attributes Non-Employee Source", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "bb361bf1-b2a0-4ae3-9c4f-d5fb8b8ea853", + "name": "A list of Schema Attributes", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n },\n {\n \"type\": \"DATE\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "10380308-1992-41ff-be34-98aafb849060", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "eb3c280b-c6b1-49ed-9953-3b3dff93890d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0d567e3d-099f-4661-a408-1ede84baad9c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16b11eac-fba4-4c7a-9220-7cb95b2b7d49", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6b34e840-1b72-4951-82b0-85617bec60c4", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "94e4e86c-777c-40fd-a78d-4558db8491d0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "28a110c2-bb92-4fd8-adbd-55bf5056cc02", + "name": "Create a new Schema Attribute for Non-Employee Source", + "request": { + "name": "Create a new Schema Attribute for Non-Employee Source", + "description": { + "content": "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`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "24b085d9-6fc7-48fa-9516-4b75b5728134", + "name": "Schema Attribute created.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ad96e98a-b685-4ecf-aeac-0e9c90314093", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c01eab2a-47ab-47e8-a639-2d3073429a98", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "64579062-c463-4b4d-a919-fd0aec11d2db", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e1a7ed9-9f68-4a3e-8cf9-c1e593cdc4d6", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0bc3a825-a72b-4d9b-9a68-4c55c6b3c066", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9aebaa6b-6fa4-4fba-a96a-48369b038813", + "name": "Delete all custom schema attributes for Non-Employee Source", + "request": { + "name": "Delete all custom schema attributes for Non-Employee Source", + "description": { + "content": "This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "4a55af37-1e61-41b6-9c3a-b4b349529595", + "name": "All custon Schema Attributes were successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "f925e95d-9e3a-4ed0-bd79-c3c7ffe38261", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a886a23-4009-44f3-9a79-7bb518a90b49", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd0dc5c4-252d-40b6-8eb2-a4b236e12b3c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab3bb2f8-a861-4d28-8a7d-82b6847808fb", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5bd8827-ef60-418b-b3be-03e7419c5b2b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{attributeId}", + "description": "", + "item": [ + { + "id": "098dd1c0-700f-43fd-8aa4-b3fc5a30a4a3", + "name": "Get Schema Attribute Non-Employee Source", + "request": { + "name": "Get Schema Attribute Non-Employee Source", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attributeId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1ed7fd23-c6cd-4390-837e-2881afed0882", + "name": "The Schema Attribute", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "702cacc3-164b-46e9-abd4-057b89c28576", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf6510ca-339c-4533-8f9a-70ec4756a94d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f23d37a0-d1ad-4071-9784-595b93f8c12b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f3c4129a-db45-40dd-ac9c-3a7ba48f8e8c", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f3ad136a-29c3-441c-b229-19922f83c9bb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f14288f3-2e9c-4a61-aa44-c55818be7758", + "name": "Patch a Schema Attribute for Non-Employee Source", + "request": { + "name": "Patch a Schema Attribute for Non-Employee Source", + "description": { + "content": "This end-point patches a specific schema attribute for a non-employee SourceId.\nRequires role context of `idn:nesr:update`\n", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attributeId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3b00f0d0-c90e-46db-8f56-ee82b446d4f3", + "name": "The Schema Attribute was successfully patched.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a3d14768-394a-49ff-b744-e9d09d35bc92", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a55fc56c-328a-427f-af2b-748af315c482", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4b43929-14fa-46ad-88d3-81b91f4ec654", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "481d1c54-bdd3-4eef-8f13-b9e0c517787b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "60759c08-82d0-4065-addd-0ee0408671bd", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7fba56f3-f0b2-45e2-825c-580fc1934afd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "91c45e9a-e2a7-4ce8-9a99-102c1e1496db", + "name": "Delete a Schema Attribute for Non-Employee Source", + "request": { + "name": "Delete a Schema Attribute for Non-Employee Source", + "description": { + "content": "This end-point deletes a specific schema attribute for a non-employee source.\nRequires role context of `idn:nesr:delete`\n", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attributeId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "b6d96d42-3ffd-4f45-a459-b9cb222535c7", + "name": "The Schema Attribute was successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "48f522ec-5283-4907-80e8-bdcc053eefdf", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8eb67e2e-84ca-4257-ba3d-1f486e4afc38", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f7a50dd5-6c7e-44ad-9cda-6976dc159691", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "59245de3-b29a-45a9-b37f-6fbd7ca9ad11", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f3943c9-1a60-4758-a6ab-57d33c6672d7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":sourceId", + "schema-attributes", + ":attributeId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "name": "non-employees", + "description": "", + "item": [ + { + "name": "download", + "description": "", + "item": [ + { + "id": "51f5d1df-a4ba-4396-93bb-23be7b25870a", + "name": "Exports Non-Employee Records to CSV", + "request": { + "name": "Exports Non-Employee Records to CSV", + "description": { + "content": "This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "69616e7c-dc46-42e9-8271-7162b5a67f4f", + "name": "Exported CSV", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{\n \"example\": \"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\"\n}", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "87c1a4d1-6756-4c72-a076-d681349af89c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f700fe18-83c9-431c-a07b-73adcb0d566b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0d4454a2-7dab-4def-8cac-ddf2b0da6984", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "22becd9e-01d6-4de2-9559-400360df5ad9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34d72e22-feb9-42c7-a178-901f3d176b0e", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2048d510-1bad-4b90-afb1-02083294da66", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employees", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "non-employee-bulk-upload", + "description": "", + "item": [ + { + "id": "37e92a0e-ea66-4ec5-8b1f-94e3a815e86b", + "name": "Imports, or Updates, Non-Employee Records", + "request": { + "name": "Imports, or Updates, Non-Employee Records", + "description": { + "content": "This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "588efc7f-a377-4a52-adac-b449567bb622", + "name": "The CSV was accepted to be bulk inserted now or at a later time.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"sourceId\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"status\": \"COMPLETED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7c13e5f5-8ec5-4419-9514-3c502693b40c", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "145b009e-099a-4746-afb3-5cd650b53742", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45565ffc-77dd-40ac-9913-3512842a2cd4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "22486d72-50d3-4643-9f86-b9e6da86c61e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ba369cd9-2e6b-4ffd-bee7-0638db419f21", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1bbb1a5d-bd2c-4bff-bd1b-1e811dab2d01", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) ", + "type": "text/plain" + }, + "key": "data", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "status", + "description": "", + "item": [ + { + "id": "84d3eb36-f459-496b-913e-32e75f3d9160", + "name": "Obtain the status of bulk upload on the source", + "request": { + "name": "Obtain the status of bulk upload on the source", + "description": { + "content": "The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.\nRequires role context of `idn:nesr:read`\n", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "bf64791c-1237-4e20-b2e6-ff2136f6dd13", + "name": "Status of the newest bulk-upload job, if any.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"status\": \"ERROR\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a075d6d8-1bb7-4b5d-9e7c-510bd318c1ec", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "909ca6d3-cecd-41e3-a263-539166738ace", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c5ed5101-c846-41bc-a73f-f41a7b12968c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "023fb3cc-663c-46aa-9e4d-45296ab6ab6a", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c41917c7-eb95-4fce-a05f-137e7c789c8e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "non-employee-bulk-upload", + "status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "schema-attributes-template", + "description": "", + "item": [ + { + "name": "download", + "description": "", + "item": [ + { + "id": "2467aa55-e62b-4e48-b515-258a067e3d2d", + "name": "Exports Source Schema Template", + "request": { + "name": "Exports Source Schema Template", + "description": { + "content": "This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9462157e-b579-493e-b734-43ee9b83ef03", + "name": "Exported Source Schema Template", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{\n \"example\": \"accountName,firstName,lastName,phone,email,manager,startDate,endDate\\n\"\n}", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "824f44d2-93ec-48dd-b849-196fbfcd00f2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "21295c16-a9b4-41d6-9a63-a6f8b2df847b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbae7477-e546-4163-9775-ce4febd7ef2c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b70911db-780a-4023-9fdb-9090b07d6e33", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d883c7db-5590-40f6-bc64-2cda2a711af2", + "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": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0bd12726-ce6f-4e0e-9b41-e6186c61a2b3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-sources", + ":id", + "schema-attributes-template", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "non-employee-approvals", + "description": "", + "item": [ + { + "id": "cfb351cd-365a-4f99-8d1b-61dbc4df452d", + "name": "Get List of Non-Employee Approval Requests", + "request": { + "name": "Get List of Non-Employee Approval Requests", + "description": { + "content": "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\ncan list the approvals for any approver.\n 2. The user owns the requested approval.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d53a270f-82a3-4c4a-acbe-31d6d8150b15", + "name": "List of approval items.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99efbfa8-938f-4524-a145-a5f1da271654", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f80e13a4-2432-4b86-971b-e25c89c30287", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf12e657-a33c-4d4e-ab60-866a5401bf15", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1a421ef-ed43-473d-91d0-250ff5ae8759", + "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": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d34fbe4-4e81-4b2a-bf87-d4ee8425f2bc", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The identity for whom the request was made. *me* indicates the current user.", + "type": "text/plain" + }, + "key": "requested-for", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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\"", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "47a17648-9311-41af-ad45-e02df7033f12", + "name": "Get a non-employee approval item detail", + "request": { + "name": "Get a non-employee approval item detail", + "description": { + "content": "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\ncan get any approval.\n 2. The user owns the requested approval.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "16d5d26c-4da2-4464-8e0b-a45677300aea", + "name": "Non-Employee approval item object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"CANCELLED\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"manager\": \"\",\n \"nonEmployeeSource\": {\n \"id\": \"\",\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"schemaAttributes\": [\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"technicalName\": \"\",\n \"label\": \"\",\n \"id\": \"\",\n \"system\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"helpText\": \"\",\n \"placeholder\": \"\",\n \"required\": \"\"\n }\n ]\n },\n \"data\": {\n \"esse0\": \"\"\n },\n \"approvalStatus\": \"NOT_READY\",\n \"comment\": \"\",\n \"completionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6108d70a-886e-4722-9563-baf62b6c3e20", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2d98f6c-ab04-40b8-a267-b8d04ea415cf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a8e9494-11c1-4504-827b-88c609be1aae", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db4cd2b4-a704-48ac-b120-2ae042db859f", + "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": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "87f0d500-1736-4b11-8733-cddd0e3dfdf1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*", + "type": "text/plain" + }, + "key": "include-detail", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "approve", + "description": "", + "item": [ + { + "id": "d7c4cdac-7809-4973-bf42-d86bf0a9edf1", + "name": "Approve a Non-Employee Request", + "request": { + "name": "Approve a Non-Employee Request", + "description": { + "content": "Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4c703e69-6b46-4680-bf60-af3ccf8fb00c", + "name": "Non-Employee approval item object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a798efb9-1074-49cc-a5c5-9a572b4481e1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "759171cb-0360-4e39-826e-55396338682c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b3b9962b-a363-4cc3-9e23-59ae5333c124", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c7abdcb7-c9c9-45b4-b58e-e718310eb511", + "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": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c34b2712-23f1-4e68-8090-b287109a82c7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "approve" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "reject", + "description": "", + "item": [ + { + "id": "6a8aaac2-fe2c-4544-b43a-5df866ac25b3", + "name": "Reject a Non-Employee Request", + "request": { + "name": "Reject a Non-Employee Request", + "description": { + "content": "This endpoint will reject an approval item request and notify user. The current user must be the requested approver.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1daedd2e-819a-414d-b8b8-bc319a420465", + "name": "Non-Employee approval item object.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"accountName\": \"\",\n \"approvalStatus\": \"NOT_READY\",\n \"approvalOrder\": \"\",\n \"comment\": \"\",\n \"modified\": \"\",\n \"created\": \"\",\n \"nonEmployeeRequest\": {\n \"id\": \"\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "be1735f2-f781-4ea4-928e-e2f4a09c7c8e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "90a6a693-d978-4cd4-be99-7a2d2662f9ee", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aec5da1b-6db5-48ac-be11-18e40bcf16ec", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "faeac0ec-285e-4e5c-9d3b-9d4cea94f4a3", + "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": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99e6c55a-82eb-4d1d-969a-4956f206a73c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + ":id", + "reject" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "summary", + "description": "", + "item": [ + { + "name": "{requested-for}", + "description": "", + "item": [ + { + "id": "e1d2ccdc-ad7d-4b77-a9ca-f1ca5c755512", + "name": "Get Summary of Non-Employee Approval Requests", + "request": { + "name": "Get Summary of Non-Employee Approval Requests", + "description": { + "content": "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\nshe 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\nas the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.", + "type": "text/plain" + }, + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "requested-for", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "72245652-a880-4705-895e-1770156a7f77", + "name": "summary of non-employee approval requests", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"approved\": \"\",\n \"pending\": \"\",\n \"rejected\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d0383fa-105b-478f-b746-e49477ced7f8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "41970478-7573-4823-9e40-31225fb3295d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c357a66-d0ba-4d15-88d4-493b82002de0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ffb2c62a-a206-45de-8839-b8734580bd68", + "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": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5eca190b-0cb8-4c11-a08e-1f0b939c8920", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "non-employee-approvals", + "summary", + ":requested-for" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "oauth-clients", + "description": "", + "item": [ + { + "id": "d6149394-ea91-4f0c-9920-cbd3b2d79a6a", + "name": "List OAuth Clients", + "request": { + "name": "List OAuth Clients", + "description": { + "content": "This gets a list of OAuth clients.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "17ca0922-e445-4b79-a4fd-8c9a574a446c", + "name": "List of OAuth clients.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"CLIENT_CREDENTIALS\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n },\n {\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"PUBLIC\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4dc3250-698d-4699-876d-2f2aa9bc639c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e3d97ae-d797-4e86-82ec-dfbde69c3bf7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4acfe9e5-7c0e-4981-bf9d-831c8308c552", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c2eb0e42-6be2-40e1-8268-c6c240c252f4", + "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": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1de1f138-b079-4a82-9751-ff4b9e574525", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "032a4cef-b75b-46c0-ad1b-0cb77da2db80", + "name": "Create OAuth Client", + "request": { + "name": "Create OAuth Client", + "description": { + "content": "This creates an OAuth client.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "bb5f61fc-04b6-4623-aa93-8baa0f6183cb", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"CLIENT_CREDENTIALS\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"ONLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "986105c3-7437-4973-ae8c-5c587bdbc1a5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "84f72ddf-a441-4928-b93c-592bb26a2152", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c7ef670f-8776-44a0-bcf5-2ffc3ff9b9b0", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95d184dd-143c-40a0-9dcc-7e45325532b6", + "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": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dd657e6a-0a75-4b28-b5c0-30b2a92598f5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"enabled\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "1db31ad5-40cf-449e-9a01-913d631df0b7", + "name": "Get OAuth Client", + "request": { + "name": "Get OAuth Client", + "description": { + "content": "This gets details of an OAuth client.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "714b7287-db6c-4aa0-8293-8c2b067b0548", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e2b229b-4073-4471-a012-64181c0a9703", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "793b5f46-c683-41db-a06d-870d0df9513a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e6d60ac-526d-4b67-9486-19bdc350e156", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "12ac1f43-1024-4ebb-89f7-70868af825f1", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1c9e3da-b184-4c69-bb7b-c01dce8269d4", + "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": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d40a5bd5-f5b4-4f1e-af9a-bf7ba58caa18", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "e2e6c1d5-4708-4887-9b30-7ce45f03b67c", + "name": "Delete OAuth Client", + "request": { + "name": "Delete OAuth Client", + "description": { + "content": "This deletes an OAuth client.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "88e6bafc-5a48-4988-a331-0c6216751b04", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "bd8e7269-582e-4295-8cb4-9bee15b16527", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5bb4936-3686-4ab6-bc67-9361291db308", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9e659da-0cb7-4e39-a7ef-0589e369261c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fc52d842-462f-426c-a33e-9a2bb317c81e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b11bddb6-980b-47ee-b1d6-ef9078fc2454", + "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": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1cf4133a-539d-490e-ae12-09b65a4446b6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "01d2bc78-e8ea-4b3f-a63d-c126f08879cb", + "name": "Patch OAuth Client", + "request": { + "name": "Patch OAuth Client", + "description": { + "content": "This performs a targeted update to the field(s) of an OAuth client.", + "type": "text/plain" + }, + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "f891423c-2cfc-4dc5-8089-3d164a36879c", + "name": "Indicates the PATCH operation succeeded, and returns the OAuth client's new representation.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"businessName\": \"\",\n \"homepageUrl\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"accessTokenValiditySeconds\": \"\",\n \"refreshTokenValiditySeconds\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"AUTHORIZATION_CODE\",\n \"REFRESH_TOKEN\"\n ],\n \"accessType\": \"OFFLINE\",\n \"type\": \"CONFIDENTIAL\",\n \"internal\": \"\",\n \"enabled\": \"\",\n \"strongAuthSupported\": \"\",\n \"claimsSupported\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"lastUsed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "462f1d83-8809-45d7-ab12-085fe46a14fe", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4217223c-89b8-4db1-8005-0e4ece9f4c84", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b73353ba-660b-46df-88bf-738628a2de6e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "efdb62d7-c2a2-401f-9546-0bc444ec6bf8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c6577e8-c9e8-4c95-a1b5-9b9e7b841216", + "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": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c209bb10-6721-4aaa-932a-065ffaa6833c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "oauth-clients", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "password-sync-groups", + "description": "", + "item": [ + { + "id": "4cce0b9c-6bc0-413a-8cff-74ff99a472df", + "name": "Get Password Sync Group List", + "request": { + "name": "Get Password Sync Group List", + "description": { + "content": "This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "ec561d5d-0263-47ad-ab85-10a921c8174c", + "name": "A list of password sync groups.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1ae2ba89-95cd-4e07-8c62-b5ee8b637fa1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d91d7454-7123-44f8-aaaa-8804b0e81efe", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2839520a-b931-4107-9de9-f3fbfba3800f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6fda3300-7cbf-4b45-aa6a-a227adc18c8b", + "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": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "22ed1ddc-0068-4f08-af9e-3becb1dec08d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4602ceca-9fc9-45b8-961e-ff9538143921", + "name": "Create Password Sync Group", + "request": { + "name": "Create Password Sync Group", + "description": { + "content": "This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3817d7f6-98e0-4f6c-aac5-6ccf0c5cb2ea", + "name": "Reference to the password sync group.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "91f3c7ad-5377-4485-87f4-8681bef37945", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a14f22b-ceba-43d5-97f9-01529c15a8bf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6596fb74-71ce-4796-a42b-d64d28da9471", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b5829fcd-cfb4-4226-8eac-4f97bb8181fa", + "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": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "05b72ec6-8a68-4054-ae0b-8696a0d6fa8f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "0936540b-0e78-45da-aae2-daddda3ad877", + "name": "Get Password Sync Group by ID", + "request": { + "name": "Get Password Sync Group by ID", + "description": { + "content": "This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "bb565f39-36bc-49f1-b63e-19a517ced821", + "name": "Reference to the password sync group.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f0f61d72-ff5b-47ac-89e7-85511a0f81ec", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "54694964-caef-454a-b88f-4d0862fec862", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0bc97d29-a8fa-4a96-a866-a77b6261a6a9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b5a87ce-a292-46b2-922b-0a8c24c547de", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c9c9233c-e9ac-4940-a07a-c46ebb48baaf", + "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": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fdd8ca34-91ea-4ad1-9389-ff7503ce6c41", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "33a288d7-967e-453e-8e0b-beda37412ebd", + "name": "Update Password Sync Group by ID", + "request": { + "name": "Update Password Sync Group by ID", + "description": { + "content": "This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "5496cb99-e4a8-4d71-bc99-e94b196f60de", + "name": "Reference to the password sync group.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6cc8b1e9-855e-405a-b5ec-1eb2c69b285f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "114a0837-c3d3-49d4-82a3-5a6a91980329", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "14784f60-8b47-4d47-9ff3-1f8b7d98f91e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea88dc21-52f1-43df-b2ec-a5b2ff93fd94", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c594d898-6aa0-4a71-8419-1bc3998c3829", + "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": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7ed86b97-c996-48cd-a5bd-2d8c3b7477d3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"passwordPolicyId\": \"\",\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f9348700-7a36-4a5a-a259-1c584d08ca1c", + "name": "Delete Password Sync Group by ID", + "request": { + "name": "Delete Password Sync Group by ID", + "description": { + "content": "This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "682b2fec-ed05-433a-acae-a4a4dfe8e895", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "5f1d6b96-3c31-43c8-8b41-e77859da360c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fca14ff7-7e65-413c-9b7e-be54ea9f7de5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2842c9f9-b752-4a3a-940c-6bacf67f0867", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff62e125-f07f-4d0e-bdda-49c1c862018c", + "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": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9eb7867-6481-4de4-8f87-be902dae7924", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-sync-groups", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "personal-access-tokens", + "description": "", + "item": [ + { + "id": "0ea264e0-487b-4de3-b0e3-f4671351d9df", + "name": "List Personal Access Tokens", + "request": { + "name": "List Personal Access Tokens", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5253f37b-5588-4065-b364-f1b234b2ab55", + "name": "List of personal access tokens.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bb91168c-12fb-4183-ab16-a7a4c7675dd3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d749103-dda5-4c27-bd53-a1d4ac83fab8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5af44854-d378-4de5-b1eb-db6040738185", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d5a6f43-3810-4ded-a5a0-fea6b89419cb", + "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": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d45ba499-27f2-4098-88f7-d0d0e60a7fee", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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'\nIf 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'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'", + "type": "text/plain" + }, + "key": "owner-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**lastUsed**: *le, isnull*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4db43269-d710-45a8-aaee-be9a61d02200", + "name": "Create Personal Access Token", + "request": { + "name": "Create Personal Access Token", + "description": { + "content": "This creates a personal access token.", + "type": "text/plain" + }, + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "9ac55fe0-67db-43f7-89c4-525ac8f322d0", + "name": "Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"secret\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fadaa78e-054b-4e3a-97a8-fdd401d7e3f3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ce3fa665-8af1-41b1-81d6-844b7de7b6d7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d2fc17d0-1029-49ac-9441-e72ec2846b6e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef9a1a72-b6e6-4a6d-84ea-3974cbcc0abe", + "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": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6733edec-34d3-452b-80ad-c0b2c1ad10ec", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "d1b24952-a95c-4a4d-9be4-1aec14ff6e2d", + "name": "Patch Personal Access Token", + "request": { + "name": "Patch Personal Access Token", + "description": { + "content": "This performs a targeted update to the field(s) of a Personal Access Token.", + "type": "text/plain" + }, + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "90390f1c-8e14-4419-a960-63993417d70a", + "name": "Indicates the PATCH operation succeeded, and returns the PAT's new representation.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": [\n \"sp:scopes:all\",\n \"sp:scopes:all\"\n ],\n \"owner\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created\": \"\",\n \"lastUsed\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98340aba-3c1c-44f5-83c3-478d9951c7fb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7d9c0409-9274-48a4-879e-5af7dc4f8895", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b2fe1c88-fd13-40d2-832d-989a89dfe887", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c94f5cc1-54b0-4e7e-b24d-79f90eef6a12", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d26496f-bb14-42d3-8ea5-73b8235abf7d", + "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": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "470a83df-4816-4b27-bcc8-93000afdffb7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "465903a7-5cd3-452e-8356-25a08c832210", + "name": "Delete Personal Access Token", + "request": { + "name": "Delete Personal Access Token", + "description": { + "content": "This deletes a personal access token.", + "type": "text/plain" + }, + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "b3d2cc4d-3278-4fb8-97a5-437d6e5a2be8", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "34bb61a0-6600-4323-8e36-230a986ea0a1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "687289b7-c19c-45f6-90a7-ebc6735d6f9d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e204f395-7275-4963-9de0-b0e86c17504c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e702b77-8452-4bd5-94d5-c7fc9e4a0df0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "25c01dc4-85b2-4529-b81a-5b6e656eeca0", + "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": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "51e8253b-395d-4503-9f5c-980a22d75165", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "personal-access-tokens", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "public-identities", + "description": "", + "item": [ + { + "id": "4ba93976-1e18-4b6c-8040-cf19b2594274", + "name": "Get a list of public identities", + "request": { + "name": "Get a list of public identities", + "description": {}, + "url": { + "path": [ + "public-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "add-core-filters", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "401d86e8-98bd-4acf-ad6b-47fc33d647d5", + "name": "A list of public identity objects.", + "originalRequest": { + "url": { + "path": [ + "public-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "add-core-filters", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"manager\": {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"manager\": {\n \"type\": \"ROLE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "04bc2cb2-d0d8-4e09-aabb-d2192e58afac", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "public-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "add-core-filters", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0dde37c3-2304-4255-a20c-308286596e83", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "public-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "add-core-filters", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "61b0cc4c-3293-4e5f-a93e-9d9efd6d6b68", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "public-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "add-core-filters", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96620207-6729-47a3-bbed-aaee531f283d", + "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": { + "url": { + "path": [ + "public-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "add-core-filters", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16c98fd1-b1df-4d4b-b6bd-2274af40bc80", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "public-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "add-core-filters", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "public-identities-config", + "description": "", + "item": [ + { + "id": "8120e9e9-6188-42e0-ad87-3f8ac80bd26f", + "name": "Get the Public Identities Configuration", + "request": { + "name": "Get the Public Identities Configuration", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "2d83958f-c95e-439a-a95f-5699dab2912c", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5784c4f5-0e48-44cd-85f2-a035692a3e18", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fd3559a1-1727-4ad3-b454-528bad5fd4ac", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "06fb3006-204f-4380-8d8a-799ad7fec6f1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0df96fda-0717-443d-896b-d64113d5e67f", + "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": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "59011f65-e6d1-4086-a532-41150eefd7d0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f8188d62-3aed-4366-941f-350eb831fa37", + "name": "Update the Public Identities Configuration", + "request": { + "name": "Update the Public Identities Configuration", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e92fbdeb-6cfd-48b1-923e-ca5d0a0f70bb", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "faf8bcf8-c30c-49e9-b3bc-e7e3f8315d01", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73d487bf-65bb-4fed-8d24-2529607d75aa", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dcbc2290-bcf1-4227-b67e-b0dfce78f952", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5b4ad10-2360-4b4d-8d56-793491057b67", + "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": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a2bd7c5-4441-4c19-935e-775ef3829748", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "public-identities-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": [\n {\n \"key\": \"\",\n \"name\": \"\"\n },\n {\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"modified\": \"\",\n \"modifiedBy\": {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "requestable-objects", + "description": "", + "item": [ + { + "id": "8dfb5e0c-6257-4da7-89eb-0cce128a62b5", + "name": "Requestable Objects List", + "request": { + "name": "Requestable Objects List", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ACCESS_PROFILE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "AVAILABLE,PENDING" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4e50233e-cbc0-4672-9a07-e2ad765009d7", + "name": "List of requestable objects", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ACCESS_PROFILE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "AVAILABLE,PENDING" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\",\n \"requestStatus\": \"AVAILABLE\",\n \"identityRequestId\": \"\",\n \"ownerRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"requestCommentsRequired\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"type\": \"ROLE\",\n \"requestStatus\": \"PENDING\",\n \"identityRequestId\": \"\",\n \"ownerRef\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"requestCommentsRequired\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1ff48748-7fdd-47d8-8f97-86eedb85c66f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ACCESS_PROFILE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "AVAILABLE,PENDING" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c6980ae-a132-4f02-9366-2149c5979692", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ACCESS_PROFILE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "AVAILABLE,PENDING" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ad482e75-e4a1-45cd-ba36-8567dc067c2d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ACCESS_PROFILE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "AVAILABLE,PENDING" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4b209c73-ecd8-432a-b9c3-77f6e4c1feb6", + "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": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ACCESS_PROFILE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "AVAILABLE,PENDING" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bdb5643a-cc6f-443f-887f-b068fb042de2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "requestable-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "identity-id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "types", + "value": "ROLE,ACCESS_PROFILE" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "term", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "statuses", + "value": "AVAILABLE,PENDING" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "roles", + "description": "", + "item": [ + { + "id": "d1748870-40f6-4a9c-83d0-a70be2be271c", + "name": "List Roles", + "request": { + "name": "List Roles", + "description": { + "content": "This API returns a list of Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "de60d1c6-3761-4e4d-bafe-49dedb13ae55", + "name": "List of Roles", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"sint4\": -19446630\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"OWNER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"NOT_EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"CONTAINS\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"IDENTITY\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"quisd\": false\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8dde8467-63e4-4af3-8379-cc489b6dee70", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a04aea4-2b2a-41dc-bfd3-92e839a1c60d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "23d63f9b-791b-410d-9ebb-c904d7edc002", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ca01f03-eeb1-4e9b-ae00-40f789312de2", + "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": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "703b07c7-1461-4199-addd-54160a31dfc9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "limit", + "value": "50" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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, created, modified**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.", + "type": "text/plain" + }, + "key": "for-segment-ids", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.", + "type": "text/plain" + }, + "key": "include-unsegmented", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "cbc412be-8171-490b-9207-3000d764fd5b", + "name": "Create a Role", + "request": { + "name": "Create a Role", + "description": { + "content": "This API creates a role.\nYou must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. \nIn addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. \nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "8cc5d140-0457-4230-b559-c3f181f1db5e", + "name": "Role created", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d61368d3-5604-4477-ab3e-0509e38d2b00", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75416f14-0142-4337-9dad-cbbd96f8dd4d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b40cd87-9139-494f-8395-9fe5ea2da656", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cd9dfaf8-757d-4721-bf1a-ca5e8ac4d19a", + "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": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1494933-5a50-4294-a390-74e7ec200ab1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "573c9211-25ec-4b88-afa9-49bad26ceaa3", + "name": "Get a Role", + "request": { + "name": "Get a Role", + "description": { + "content": "This API returns a Role by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "bcbdc159-8327-40e1-853c-42123bba5610", + "name": "List of all Roles", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c12b3665-8fe4-4b13-9614-958afca64791", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "55668c9f-f21a-4a46-8cc6-bca6dd10811f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5c286aec-9649-49d4-be5a-d5ed33725494", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "daf7ce3b-e019-4c3f-9739-85daa2f45d31", + "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": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3c2c483d-fd91-4583-88ba-34809018fd6c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0255f0bb-6016-44dd-9cc7-ab6f6cc2f202", + "name": "Patch a specified Role", + "request": { + "name": "Patch a specified Role", + "description": { + "content": "This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "3f098e45-6a58-4598-b2c0-c5bcfd18a241", + "name": "Responds with the Role as updated.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"accessProfiles\": [\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"\"\n }\n ],\n \"membership\": {\n \"type\": \"STANDARD\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"OR\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n },\n {\n \"operation\": \"STARTS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\",\n \"children\": [\n {\n \"operation\": \"AND\",\n \"key\": {\n \"type\": \"ENTITLEMENT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n },\n {\n \"operation\": \"ENDS_WITH\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"\",\n \"sourceId\": \"\"\n },\n \"stringValue\": \"\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n },\n {\n \"type\": \"TAG\",\n \"id\": \"\",\n \"name\": \"\",\n \"aliasName\": \"\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"elit_4\": \"enim sunt ut\",\n \"eiusmod5c\": -45545517\n },\n \"enabled\": false,\n \"requestable\": false,\n \"accessRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n },\n {\n \"approverType\": \"MANAGER\",\n \"approverId\": \"\"\n }\n ]\n },\n \"revocationRequestConfig\": null,\n \"segments\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "166a7f30-2bcb-45c9-9b5e-fe36c33b726f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d0e4fc8-2a87-4374-8e8a-940c30c18912", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fe751c42-74a6-4c99-a8fd-f2d962570778", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99898008-9657-4b55-8210-a187abb7b642", + "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": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d8f32dd-0d3d-4c04-99e3-5a51f78e9822", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "assigned-identities", + "description": "", + "item": [ + { + "id": "b4bff8e9-ba74-4443-a836-c04ea9a646fa", + "name": "List Identities assigned a Role", + "request": { + "name": "List Identities assigned a Role", + "description": {}, + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1160402c-24b1-4380-a10a-de5680c9c410", + "name": "List of Identities assigned the Role", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"aliasName\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"roleAssignmentSource\": \"ROLE_MEMBERSHIP\"\n },\n {\n \"id\": \"\",\n \"aliasName\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"roleAssignmentSource\": \"ROLE_MEMBERSHIP\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ade127dd-c101-4a42-93a5-1719b6718f32", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4dba281-33fb-42c1-807b-80853718661b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5ad94809-8345-463b-99a7-695e3897f20d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8808332a-7f96-4961-9d22-3f07870f28b8", + "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": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9b091643-b01a-4052-a8a8-d74ecb57e46e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id", + "assigned-identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**, **aliasName**, **email**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "saved-searches", + "description": "", + "item": [ + { + "id": "8c0b2b58-0381-417a-9f2f-285586bfe41a", + "name": "Create a saved search", + "request": { + "name": "Create a saved search", + "description": { + "content": "Creates a new saved search.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "saved-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"*\",\n \"roles\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"Lorem_9\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"sed_4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2de70397-02ea-4ab4-9fc3-ba18b650182f", + "name": "The persisted saved search.", + "originalRequest": { + "url": { + "path": [ + "saved-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"*\",\n \"roles\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"Lorem_9\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"sed_4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a332554-c6fd-4552-bc7c-afdcc737415a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "saved-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"*\",\n \"roles\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"Lorem_9\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"sed_4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dfd8c51c-c37b-4e39-94f6-41bade056327", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "saved-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"*\",\n \"roles\"\n ],\n \"query\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"Lorem_9\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"sed_4\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "917a0ff1-8a31-4c29-bad0-da4111be15bf", + "name": "Return a list of Saved Searches", + "request": { + "name": "Return a list of Saved Searches", + "description": { + "content": "Returns a list of saved searches.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "saved-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "7b27b754-c44e-4689-9674-10b0dead3657", + "name": "The list of requested saved searches.", + "originalRequest": { + "url": { + "path": [ + "saved-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "The total result count (returned only if the *count* parameter is specified as *true*).", + "type": "text/plain" + }, + "key": "X-Total-Count", + "value": "" + } + ], + "body": "[\n {\n \"indices\": [\n \"*\",\n \"events\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"do46\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"TERMS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n },\n {\n \"indices\": [\n \"identities\",\n \"events\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"sunt__33\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ],\n \"deserunt_a\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45b17ebc-9346-4c49-b80b-dfd4a9162cd0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "saved-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c758527a-2a10-4967-ad8e-6ecee4fe9d22", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "saved-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "3df5e1a3-2309-40e4-a010-d93f30eb691b", + "name": "Updates an existing saved search\n", + "request": { + "name": "Updates an existing saved search\n", + "description": { + "content": "Updates an existing saved search. \n\n>**NOTE: You cannot update the `owner` of the saved search.**\n", + "type": "text/plain" + }, + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "6c5d9dce-8752-48b8-980b-c3dc7c64362e", + "name": "The persisted saved search.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0a39408-0339-420e-a312-e835a990f67c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ca66237a-568f-4835-8636-950c214165c0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "698e282a-e5b5-4ca1-9be1-d914ee28c9bb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "881e06d8-8661-4f61-b6e0-9c4a203039b1", + "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": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ffde00b-413f-422c-8c27-6091e56dbd50", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "db881c45-6853-4318-9110-61e0b0b18d44", + "name": "Return saved search by ID", + "request": { + "name": "Return saved search by ID", + "description": { + "content": "Returns the specified saved search.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d53d04c3-7eba-451f-9fd8-ad2c2629af81", + "name": "The requested saved search.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"indices\": [\n \"roles\",\n \"entitlements\"\n ],\n \"query\": \"\",\n \"id\": \"\",\n \"owner\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"public\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"columns\": {\n \"dolore_9e8\": [\n {\n \"field\": \"\",\n \"header\": \"\"\n },\n {\n \"field\": \"\",\n \"header\": \"\"\n }\n ]\n },\n \"fields\": [\n \"\",\n \"\"\n ],\n \"sort\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fe1d259b-2fc9-47b1-807b-780cefaa03d8", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "29ac28ad-11b2-44af-a283-62f7490397c6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75e94690-6c43-4fb8-a148-07c2877c4059", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99922a5d-fa70-4521-9d03-1b226194237e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a952e7b-32bd-4a99-a380-664a9527049d", + "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": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7eb82741-8389-4cf0-9267-dc2e922790c2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f427a606-4c28-41c8-9cf0-1ef7802f94a8", + "name": "Delete document by ID", + "request": { + "name": "Delete document by ID", + "description": { + "content": "Deletes the specified saved search.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "732d9bb4-097c-4173-a8d0-4602f89850d0", + "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "0be54af5-3868-48ce-a57a-e33e4ee95622", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "293327f5-cb33-458e-80ac-f75b6da1d3cf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26f83dd4-1d9a-410f-9d13-2e102cb172b2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf32c6f2-5d2e-4fe9-a33a-861e1d02c3b4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa87f04c-34ca-4829-bce1-fad827deba6e", + "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": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "564a2d28-d5e6-4d19-86fa-fa55c6e4e06d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "execute", + "description": "", + "item": [ + { + "id": "4b5c58ca-b7b5-4ce1-8cf1-f03596fca336", + "name": "Execute a saved search by ID", + "request": { + "name": "Execute a saved search by ID", + "description": { + "content": "Executes the specified saved search.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "saved-searches", + ":id", + "execute" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7645eba3-7eaa-40a3-a2f5-8f067ee2a882", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id", + "execute" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "92b6acf3-78a8-4f80-8cf9-0e516dd60f0b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id", + "execute" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "206c939f-56d5-4594-84d1-d9ea375849a7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id", + "execute" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c7b23acd-c36f-480c-bc93-439da633d91c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id", + "execute" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8fd4a2b0-1b95-4d47-b4ca-59a219f5fdb9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id", + "execute" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "870112ac-8526-4cb9-a190-a1af76a5a7cd", + "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": { + "url": { + "path": [ + "saved-searches", + ":id", + "execute" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5e6d25b-3e4d-4c2d-8d30-6b3562ce8261", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "saved-searches", + ":id", + "execute" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"scheduleId\": \"\",\n \"owner\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"CERTIFICATION\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "scheduled-searches", + "description": "", + "item": [ + { + "id": "c15f1ab8-fd9c-4991-bbeb-35829b9adfce", + "name": "Create a new scheduled search", + "request": { + "name": "Create a new scheduled search", + "description": { + "content": "Creates a new scheduled search.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4fa86a1d-b22b-4c84-ab68-181b38fd425c", + "name": "The persisted scheduled search.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2f5af0c-5bd1-47e7-8227-1bc5aa4812eb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "abdd7fd6-19ff-49c9-8b9f-3a0c9965612d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc1a1999-f6e1-4168-9a4a-dfe526bde684", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d519e7c2-a779-40cf-a3ab-92547954649d", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a33bab47-f4d9-4464-b765-aedb246a7a46", + "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": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e6aa7b8f-ac29-49ab-a8f9-868a73bad5dd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "228e3de9-1a21-4b06-9f9c-129334055d11", + "name": "List scheduled searches", + "request": { + "name": "List scheduled searches", + "description": { + "content": "Returns a list of scheduled searches.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "dea7bb7c-83fd-40b5-956f-6c0c89045f66", + "name": "The list of requested scheduled searches.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "The total result count (returned only if the *count* parameter is specified as *true*).", + "type": "text/plain" + }, + "key": "X-Total-Count", + "value": "" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"MONTHLY\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n },\n {\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1f0778e-7b22-445e-992d-7401e70227f3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a9403946-6ec0-4baa-b64e-07059765377c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4dcd4fc6-ffed-4c9b-a9c3-dfaa636f9911", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3bafb538-98af-4aaa-bed6-a1baac330833", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "de3bea34-77e4-44f2-af9a-94b33cddfa68", + "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": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f0be6d7-6768-447f-8fe9-78c2aa16c1fb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e984fca7-705e-40ed-9daf-94bc947f36f4", + "name": "Update an existing Scheduled Search", + "request": { + "name": "Update an existing Scheduled Search", + "description": { + "content": "Updates an existing scheduled search.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "bcbbe394-2682-4262-a78c-1d2e221e08a0", + "name": "The persisted scheduled search.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d287d512-4eee-4ade-aafe-29411e65cfa1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17a2cde6-da4c-4039-8740-8a2eff873372", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "69bce683-d7b9-45b2-adbb-38ca572caaf5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3d11d304-4910-42f3-a288-c064a5b22f25", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "af8dca69-2a36-472c-b2d2-90927d9bb1cc", + "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": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b16d970-851f-4a5c-be1f-8abaf3fa356b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "65853794-0d98-4105-a607-681dd079244f", + "name": "Get a Scheduled Search", + "request": { + "name": "Get a Scheduled Search", + "description": { + "content": "Returns the specified scheduled search.", + "type": "text/plain" + }, + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "abf2d2ce-db23-4107-9f2d-734d868dc6a5", + "name": "The requested scheduled search.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n \"ownerId\": \"\",\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n },\n {\n \"type\": \"IDENTITY\",\n \"id\": \"\"\n }\n ],\n \"savedSearchId\": \"\",\n \"schedule\": {\n \"type\": \"DAILY\",\n \"hours\": {\n \"type\": \"LIST\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b23fde78-eb12-40c4-8074-c5cb383367ce", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5f631e10-7cb3-4302-8c71-94a7baf9ed8b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5897524e-2188-4cc0-9e99-7ab324faa710", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "85dcbcba-1b83-414e-b4b8-ea8ffa739fed", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6ca2703-6c72-4b90-b233-94932f54416e", + "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": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ad6c9aec-480e-4cf3-8192-b7ddd52eecaa", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "46f70747-1ed7-4302-9c81-4959774b08e0", + "name": "Delete a Scheduled Search", + "request": { + "name": "Delete a Scheduled Search", + "description": { + "content": "Deletes the specified scheduled search.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "356b7d45-b965-4a36-8a4d-f5fdad64cb8f", + "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "0b9b2d4c-1f5a-44bc-b692-40d60bb304fd", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5119fe69-eace-4845-9f8a-fbe6c16577e8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "140ca6a4-f2e3-4f0e-9bac-9e6b6c96c2cd", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "76e78820-1802-49d0-8998-a42641e7f4ca", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a6d4cea-eb50-4f03-b25d-1cc321c30ab8", + "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": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b395fbf1-e1e4-4d07-8226-46c3e289d356", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "unsubscribe", + "description": "", + "item": [ + { + "id": "a51a6f63-9b75-465e-bae4-091207cd97a3", + "name": "Unsubscribe a recipient from Scheduled Search", + "request": { + "name": "Unsubscribe a recipient from Scheduled Search", + "description": { + "content": "Unsubscribes a recipient from the specified scheduled search.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "scheduled-searches", + ":id", + "unsubscribe" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a353685d-a172-4d88-a068-59f7f42b3137", + "name": "No Content - Indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id", + "unsubscribe" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "258df6da-98dd-42ac-b677-7dc57c4dc02c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id", + "unsubscribe" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6c64069-74fe-4c14-b1fb-717e685e40b6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id", + "unsubscribe" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3b5e826-6fd6-431a-bd9c-4ad9b4c734c1", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "scheduled-searches", + ":id", + "unsubscribe" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"LIFECYCLE_STATE\",\n \"id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "search", + "description": "", + "item": [ + { + "id": "2232b963-ba6a-40fc-a03c-9a6383b24073", + "name": "Perform Search", + "request": { + "name": "Perform Search", + "description": { + "content": "Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ", + "type": "text/plain" + }, + "url": { + "path": [ + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "cef5161c-22b7-4a49-9fef-97f58ccdb4d7", + "name": "List of matching documents.", + "originalRequest": { + "url": { + "path": [ + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "The total result count (returned only if the *count* parameter is specified as *true*).", + "type": "text/plain" + }, + "key": "X-Total-Count", + "value": "" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"accountactivity\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"RULE\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"accountactivity\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"APPLICATION\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16606e72-8b4d-4127-86f6-a123d8caf66d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a6c8f0ae-95d8-4870-859b-fb8c2e030244", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35992c78-3680-4827-a5a1-ad0308d1b66a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b9513c2-46cd-449b-89d2-6c75fdff2b0a", + "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": { + "url": { + "path": [ + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fa7eb402-61ac-435c-be31-452ccf9f3c74", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "count", + "description": "", + "item": [ + { + "id": "39beb7cd-dfb4-4256-960f-2d8fa507ff0f", + "name": "Count Documents Satisfying a Query", + "request": { + "name": "Count Documents Satisfying a Query", + "description": { + "content": "Performs a search with a provided query and returns the count of results in the X-Total-Count header.", + "type": "text/plain" + }, + "url": { + "path": [ + "search", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4002c235-050d-49f4-b34d-be82485ce486", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "search", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [ + { + "disabled": false, + "description": { + "content": "The total result count.", + "type": "text/plain" + }, + "key": "X-Total-Count", + "value": "" + } + ], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "b0ee0150-fb0f-40c0-a3fd-2962b9fd971f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "search", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "939223fb-9711-43f0-885c-403fb68185f7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "search", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b3617024-f7e9-486a-b7f3-c67e37d08029", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "search", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c7a32d3-8d89-44ea-9041-57c0428b63c4", + "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": { + "url": { + "path": [ + "search", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33ce4052-39c3-4854-abeb-734fe548cf5e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "search", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "aggregate", + "description": "", + "item": [ + { + "id": "7c5d9f00-44c2-4e75-8292-f64368cf1170", + "name": "Perform a Search Query Aggregation", + "request": { + "name": "Perform a Search Query Aggregation", + "description": { + "content": "Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ", + "type": "text/plain" + }, + "url": { + "path": [ + "search", + "aggregate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "be2f3e27-a5cf-4989-b38a-4bf29b75f86a", + "name": "Aggregation results.", + "originalRequest": { + "url": { + "path": [ + "search", + "aggregate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "The total result count (returned only if the *count* parameter is specified as *true*).", + "type": "text/plain" + }, + "key": "X-Total-Count", + "value": "" + } + ], + "body": "{\n \"aggregations\": {},\n \"hits\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"event\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ACCOUNT\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"entitlement\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ENTITLEMENT\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c5517a97-2fdd-4af2-aafb-ca64c313d9c0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "search", + "aggregate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2322feb6-771d-41cb-8dd7-153848ecc034", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "search", + "aggregate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6d4d7ab6-c4bf-4863-87c5-02ffcbb9cdf2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "search", + "aggregate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b07cd55a-db34-437f-8425-5b6f0998071f", + "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": { + "url": { + "path": [ + "search", + "aggregate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e44c6fac-f5b9-4bb5-b28e-30eaca61798e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "search", + "aggregate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"indices\": [\n \"events\",\n \"identities\"\n ],\n \"queryType\": \"SAILPOINT\",\n \"queryVersion\": \"5.2\",\n \"query\": {\n \"query\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"timeZone\": \"\",\n \"innerHit\": {\n \"query\": \"\",\n \"type\": \"\"\n }\n },\n \"queryDsl\": {},\n \"textQuery\": {\n \"terms\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"matchAny\": false,\n \"contains\": false\n },\n \"typeAheadQuery\": {\n \"query\": \"\",\n \"field\": \"\",\n \"nestedType\": \"\",\n \"maxExpansions\": 10\n },\n \"includeNested\": true,\n \"queryResultFilter\": {\n \"includes\": [\n \"\",\n \"\"\n ],\n \"excludes\": [\n \"\",\n \"\"\n ]\n },\n \"aggregationType\": \"DSL\",\n \"aggregationsVersion\": \"5.2\",\n \"aggregationsDsl\": {},\n \"aggregations\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n },\n \"subAggregation\": {\n \"nested\": {\n \"name\": \"\",\n \"type\": \"\"\n },\n \"metric\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"UNIQUE_COUNT\"\n },\n \"filter\": {\n \"name\": \"\",\n \"field\": \"\",\n \"value\": \"\",\n \"type\": \"TERM\"\n },\n \"bucket\": {\n \"name\": \"\",\n \"field\": \"\",\n \"type\": \"TERMS\",\n \"size\": \"\",\n \"minDocCount\": \"\"\n }\n }\n }\n },\n \"sort\": [\n \"\",\n \"\"\n ],\n \"searchAfter\": [\n \"\",\n \"\"\n ],\n \"filters\": {\n \"laboris0\": {\n \"type\": \"EXISTS\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"qui_3a\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n },\n \"pariatur_59\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"\",\n \"inclusive\": false\n },\n \"upper\": {\n \"value\": \"\",\n \"inclusive\": false\n }\n },\n \"terms\": [\n \"\",\n \"\"\n ],\n \"exclude\": false\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{index}", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "c34a3812-11f4-4775-b938-40a1bc7c8054", + "name": "Get a Document by ID", + "request": { + "name": "Get a Document by ID", + "description": { + "content": "Fetches a single document from the specified index, using the specified document ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "search", + ":index", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "index", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e8978d73-1644-4960-b604-d19561591aff", + "name": "The requested document.", + "originalRequest": { + "url": { + "path": [ + "search", + ":index", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"_type\": \"account\",\n \"description\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"synced\": \"\",\n \"enabled\": \"\",\n \"requestable\": \"\",\n \"requestCommentsRequired\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"ACCESS_PROFILE\",\n \"email\": \"\"\n },\n \"source\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entitlements\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attribute\": \"\",\n \"value\": \"\"\n }\n ],\n \"entitlementCount\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "322e2d8e-f7b0-4f72-bd85-42142ef57008", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "search", + ":index", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9130fdc-81e3-4ea2-8316-380a783c4548", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "search", + ":index", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a982d97-b9e5-41a6-a09e-e014da342f86", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "search", + ":index", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b6deac8-0ae1-4baa-872b-865b813bb4aa", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "search", + ":index", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "394fa97e-60ee-4a1c-8523-168f6f1d2c15", + "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": { + "url": { + "path": [ + "search", + ":index", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c2f79c8b-15e2-4bdd-895e-79d410dffa5b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "search", + ":index", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "segments", + "description": "", + "item": [ + { + "id": "0624bbd8-09be-4c32-adb1-8c966c07eb2a", + "name": "Create Segment", + "request": { + "name": "Create Segment", + "description": { + "content": "This API creates a segment. \n>**Note:** Segment definitions may take time to propagate to all identities.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "bd06007b-b273-466d-a1d8-b1d49d3b718b", + "name": "Segment created", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "855ec370-343a-4e0a-99f3-a465710166cb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "842ee682-773e-4150-a203-97d22751b528", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42fe721e-ab51-40d1-bb86-e0b68532495c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3494214f-6014-4789-80f2-04d6e169aec8", + "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": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5061cb59-c3eb-4406-8442-750a395c8df1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9de9f1e0-96cf-4254-b492-5dd07f316fd9", + "name": "List Segments", + "request": { + "name": "List Segments", + "description": { + "content": "This API returns a list of all segments. \nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e1483d84-9724-47d3-977c-43f8fd2e0ad4", + "name": "List of all segments", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_REQUEST\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"AND\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2683ddd-df68-45b1-b225-1047ab668fb5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ef36d7ad-32d3-4c0f-b50e-d4fcf81ea18e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4a7fe75-1553-40db-95c3-a2ed6312b3b9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "78888c1f-10a0-451e-8941-e48a15f3e452", + "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": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d0bb1ad8-354c-49b8-900c-05112cfb5fcd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "64ad5b96-6371-45e0-9422-c2efe98d4e07", + "name": "Get Segment by ID", + "request": { + "name": "Get Segment by ID", + "description": { + "content": "This API returns the segment specified by the given ID.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3f2501f3-5782-4115-a898-4c871f12fb1f", + "name": "Segment", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34cfe170-7234-4296-9694-e7a1892ea76b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc3d5dfe-d223-4298-8c64-5d7b503cf073", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6cf04bcf-5db9-4afb-afea-f97a22a40ff7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "068a7e8c-57cb-41ef-8fbf-2d250fca2c3f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d22c3fa6-c066-4ba6-a98e-f1ac54e8e6e8", + "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": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9304590-e5f8-4a85-8b34-5f61e111431a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "cd0cbefe-352a-4667-9512-5f14108d5102", + "name": "Delete Segment by ID", + "request": { + "name": "Delete Segment by ID", + "description": { + "content": "This API deletes the segment specified by the given ID.\n>**Note:** that segment deletion may take some time to become effective.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "1a49734d-aca6-4397-8027-9136ef21e614", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "703df96e-bc11-43d8-9e4b-cb5f493b2b93", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1fd26473-a748-46f5-a5c5-6f2a59c67684", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d8584ec7-534e-4139-94fc-160fc408c94c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0804c26-52bf-48b8-b5f6-1d87cf920fc2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "86976f72-6fa7-40c1-b743-db04e0a227c0", + "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": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6688a69a-e9fb-4082-98e9-e08e5b20c3a4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "15283714-05a4-471b-9910-4edd706df85f", + "name": "Update Segment", + "request": { + "name": "Update Segment", + "description": { + "content": "Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n>**Note:** Changes to a segment may take some time to propagate to all identities.\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d2f0f6ba-68fd-4f80-9ec0-ddc1ce9064c9", + "name": "Indicates the PATCH operation succeeded, and returns the segment's new representation.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"\",\n \"value\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"children\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"active\": false\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e2e5c195-0af3-4f68-abab-6fe1e892e642", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99958fb3-2dae-4e58-a5c3-215a72e1982a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "583ecaef-e20f-43d0-9f72-47dcfd9eb361", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e817e40-d230-47bb-9262-728fc4b7cdb4", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2eb78cc8-3699-4acf-9bf2-ce82024d66d6", + "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": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a9f672b-cbd5-4030-84bc-281d5ac406ff", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "segments", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "service-desk-integrations", + "description": "", + "item": [ + { + "id": "f90a12e1-67be-4eff-998f-13652404caf4", + "name": "List existing Service Desk Integrations", + "request": { + "name": "List existing Service Desk Integrations", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "74777810-7c0e-4f23-80bb-ca6e582b4038", + "name": "List of ServiceDeskIntegrationDto", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"attributes\": {\n \"enim7\": -19102266.512672454,\n \"proident5\": 1464796.3317423314,\n \"consequat_7e\": \"aute tempor ea\",\n \"cupidatat_1ee\": 81493109\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"attributes\": {\n \"sunt_3\": false\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9a35d8f-1140-4997-8bf5-b3f8eb96204b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "79b22819-b18c-4055-8041-68c879f161ca", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99ef9780-516f-48b5-95de-a0d3f6edc4bb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b5bcb7ef-47c9-467b-94be-ea1b34cab131", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65a98594-46ea-4097-a2f2-be54b8dc8d4a", + "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": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e5523aa-32c1-42a6-a421-4057c4bb4563", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "0c9dc6cf-23e2-408c-8833-c568c8cc755c", + "name": "Create new Service Desk integration", + "request": { + "name": "Create new Service Desk integration", + "description": { + "content": "Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e5072e00-0a91-4764-8cad-4c9543f18076", + "name": "details of the created integration", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5cc31baf-0465-47a3-b7e6-6d33e17d101d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c1cb3b3d-26da-4259-8202-29c6fefab3f1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57b184a3-b90a-4cc1-aac1-17712fe95b48", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "05332f79-49ee-475d-8674-83538ed50538", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c15092e6-50bd-428f-bbf2-57a347822ec4", + "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": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0158a0b6-117f-44cb-8f91-05f484ec308d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "2f823d45-faa7-48cc-b1f8-bd1c28a887c7", + "name": "Get a Service Desk integration", + "request": { + "name": "Get a Service Desk integration", + "description": { + "content": "Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "01a7113b-0d7b-4705-92de-bc584ba434fa", + "name": "ServiceDeskIntegrationDto with the given ID", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "883e306c-6506-47e5-95f0-15e52d2fdc1c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3dca9b34-cb8c-4df5-8ffd-6b2d54290caf", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c7fa851-fcf6-43be-b21d-a59aae1bc0a6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "936977ca-fcb3-4faf-9c3a-c167ab45f8d9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "213642fd-55dc-45e5-946b-2e6e55a080aa", + "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": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f1287c4-dcd8-4e47-a130-a2876c6fdf4a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "7aef1e65-7a76-4548-b847-64eed869b95d", + "name": "Update a Service Desk integration", + "request": { + "name": "Update a Service Desk integration", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4d49433e-7625-4bd8-a63e-6f12e5d64bb6", + "name": "ServiceDeskIntegrationDto as updated", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1607bb82-453b-4803-bbcb-92660985b743", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ea3c24e8-cc3e-4c51-89d0-461488a061f5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b3377045-6f6c-4481-b6c8-975f63900f4c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "19ec3493-f5a3-43b2-ae19-9a468641b168", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5485876-8c26-4670-8a2c-95a91551494c", + "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": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e63248c-7129-454e-a924-4587014d8b76", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "18608413-8977-4a2c-8d10-6d9e088e4bb7", + "name": "Delete a Service Desk integration", + "request": { + "name": "Delete a Service Desk integration", + "description": { + "content": "Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "73940528-498e-4319-86fc-ee101cc19a5a", + "name": "Service Desk integration with the given ID successfully deleted", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "d7f8bb19-52b4-46a6-8d27-f46200742720", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bdf0a17e-48dd-4b0c-ae29-6bc8fdc747d4", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81072f0e-6dde-4a33-9c01-fa8bbdf46883", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4c9df32a-63c7-4451-b8d9-3db7839c1a98", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b815ad2-e508-4595-8e6a-a3b7e673ca98", + "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": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d416636e-833f-4144-bf47-ad55c34dc160", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "78b1f013-8bd2-4329-9aee-28391ccbf9bf", + "name": "Service Desk Integration Update PATCH", + "request": { + "name": "Service Desk Integration Update PATCH", + "description": { + "content": "Update an existing ServiceDeskIntegration by ID with a PATCH request.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "27b11d3d-d403-435b-a217-b1546c194a36", + "name": "ServiceDeskIntegrationDto as updated", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"consectetur_7\": -31947376.971140206,\n \"quis_504\": 88694600.93597782\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"ServiceNowSDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"cluster\": \"\",\n \"managedSources\": [\n \"\",\n \"\"\n ],\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e421b008-46b4-4d2b-b2ad-c4d631e8a522", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "50b96863-f325-4784-baad-a4006130340b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "53c4b56a-fbf5-4402-9661-0df7ee867457", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "513ca8ce-67c7-4480-831a-13912d163f4f", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5598ae2f-0098-41f6-882b-a7edc259b663", + "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": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "46949364-91ab-4a28-bb0f-023c63cdca2d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "types", + "description": "", + "item": [ + { + "id": "078f23f5-059c-40f1-a976-6a5dcb3eaff2", + "name": "Service Desk Integration Types List.", + "request": { + "name": "Service Desk Integration Types List.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f544ef2b-54b2-4e54-8174-c5541f55bf1d", + "name": "Responds with an array of the currently supported Service Desk integration types.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"type\": \"\",\n \"scriptName\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"\",\n \"scriptName\": \"\",\n \"name\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "afc71f48-4516-4434-a117-a69889eb432d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0219dbcd-5b37-4a0e-a832-bde0862381ff", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aca4b0bd-737a-45a7-94a8-55f5a06da1f4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1d26fa3-5c81-4a30-8aa6-a81fc4ef789d", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb9cee41-55a1-4706-b325-4b74cac018c4", + "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": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bdec4dd2-b573-49e3-981e-6810a0e34b0b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "templates", + "description": "", + "item": [ + { + "name": "{scriptName}", + "description": "", + "item": [ + { + "id": "15e27bcf-742f-44f6-9fd6-ffd8fe2f8228", + "name": "Service Desk integration template by scriptName.", + "request": { + "name": "Service Desk integration template by scriptName.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "scriptName", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "39b1af71-58ed-4a1b-a4e4-bf8976fcfc76", + "name": "Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"attributes\": {\n \"ex7\": false\n },\n \"name\": \"\",\n \"provisioningConfig\": {\n \"universalManager\": \"\",\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"\"\n },\n \"noProvisioningRequests\": \"\",\n \"provisioningRequestExpiration\": \"\"\n },\n \"type\": \"Web Service SDIM\",\n \"id\": \"\",\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e2c4eff-83e1-4958-b8e5-ef138e4fe13a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f05fc9ab-7a7c-44cc-994d-61f3ad66bb73", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "69cc3809-439b-4c7d-b7e5-6b52c3f126a3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6ba57674-5f3f-466a-96f5-00907fcb8ec8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4ad3430d-b7ca-488b-a59c-09661f6eed73", + "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": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32539df4-d7bf-429e-ac7a-8a83350454f9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "templates", + ":scriptName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "status-check-configuration", + "description": "", + "item": [ + { + "id": "b9ef2883-871b-4251-973e-712952497fe6", + "name": "Get the time check configuration", + "request": { + "name": "Get the time check configuration", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "fb2e3138-5153-4b41-a72e-81e75dd8cbaa", + "name": "QueuedCheckConfigDetails containing the configured values", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b51a2969-4b39-41ad-b333-6533dcf23a7b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "596adbf7-5c5d-4970-be5d-9cf0301b10ec", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8531beb3-d33f-42e5-832f-e60597329d0a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ab225065-e68d-460b-9a32-cb77ef5913e9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0f0eeed1-aca6-4c2f-8291-494ce9e90d1e", + "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": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f803c84a-0803-4fca-9bce-3e73148b1eda", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "6cf8a96b-ed64-414b-95e1-642b21db786c", + "name": "Update the time check configuration", + "request": { + "name": "Update the time check configuration", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "38d17ae2-2b6b-450f-b030-daf89fca431b", + "name": "QueuedCheckConfigDetails as updated", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "34491e9b-0768-449e-aee8-4daa7b37f7ad", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40d8010d-0607-4c1a-8ef9-1e3ebc9fca8b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73cfc6ad-825c-4dbf-91bc-5ea39c9068ed", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1aecbb1-8ce2-44dc-b63a-4d772d8907ee", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d98a6881-778c-4f4f-be49-b75f3a9dac94", + "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": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cd1803ee-340e-4946-9032-5e9d83f075c3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "service-desk-integrations", + "status-check-configuration" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"provisioningStatusCheckIntervalMinutes\": \"\",\n \"provisioningMaxStatusCheckDays\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "query-password-info", + "description": "", + "item": [ + { + "id": "825515b4-b332-457b-ad32-bd4fb8f0f6cb", + "name": "Query Password Info", + "request": { + "name": "Query Password Info", + "description": { + "content": "This API is used to query password related information. \n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) \nis required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" \ngrant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) \nor a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) \ngrant type will **NOT** work on this endpoint, and a `403 Forbidden` response \nwill be returned.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "de1c4b09-2464-47da-9b95-c378be2ea7c8", + "name": "Reference to the password info.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identityId\": \"\",\n \"sourceId\": \"\",\n \"publicKeyId\": \"\",\n \"publicKey\": \"\",\n \"accounts\": [\n {\n \"accountId\": \"\",\n \"accountName\": \"\"\n },\n {\n \"accountId\": \"\",\n \"accountName\": \"\"\n }\n ],\n \"policies\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "29b1af30-66e5-4e18-9024-e245baee8520", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a509dd96-0315-46d5-86cd-e46667517561", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bff9e7b4-37b1-4e4e-aa5c-a5ed7362f195", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "99d8144c-b700-48d3-937a-fd5ccafb5f18", + "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": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40988506-f3e1-40fb-b6c3-3d243fa87da5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "query-password-info" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"userName\": \"\",\n \"sourceName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "set-password", + "description": "", + "item": [ + { + "id": "82431d47-019d-449f-a62b-f7af13e71715", + "name": "Set Identity's Password", + "request": { + "name": "Set Identity's Password", + "description": { + "content": "This API is used to set a password for an identity. \n\nAn identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).\n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. \n\"API authority\" refers to a token that only has the \"client_credentials\" grant type.\n\nYou can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). \nTo do so, follow these steps:\n\n1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. \n\n2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. \n\n3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password:\n\n```java\nimport javax.crypto.Cipher;\nimport java.security.KeyFactory;\nimport java.security.PublicKey;\nimport java.security.spec.X509EncodedKeySpec;\nimport java util.Base64;\n\nString encrypt(String publicKey, String toEncrypt) throws Exception {\n byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey);\n byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\"));\n return Base64.getEncoder().encodeToString(encryptedBytes);\n}\n\nprivate byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception {\n PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes));\n String transformation = \"RSA/ECB/PKCS1Padding\";\n Cipher cipher = Cipher.getInstance(transformation);\n cipher.init(1, key);\n return cipher.doFinal(toEncryptBytes);\n}\n``` \n\nIn this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. \n\nYou can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. \n", + "type": "text/plain" + }, + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "4c0c4a43-2a95-4e14-b083-539f0270500e", + "name": "Reference to the password change.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"requestId\": \"\",\n \"state\": \"FINISHED\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "444fde17-bdef-4724-ae41-38198d4c0ed6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f91c716d-6c79-425b-8e2a-a9592d811c8a", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "faaf2547-3a40-4088-9e27-ce51975a9e01", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff6f5412-3701-4dad-ba1c-48cdd3696b14", + "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": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bac0d49c-e783-404b-ac87-e6efa216368c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "set-password" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"encryptedPassword\": \"\",\n \"publicKeyId\": \"\",\n \"accountId\": \"\",\n \"sourceId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "password-change-status", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "b994a8a7-7a93-4a87-9ce8-63cc68d56bbd", + "name": "Get Password Change Request Status", + "request": { + "name": "Get Password Change Request Status", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e876803a-6e79-45e3-800c-df76775139bc", + "name": "Status of the password change request", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"requestId\": \"\",\n \"state\": \"FAILED\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"sourceIds\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1c08d60-91a0-4ea2-896e-a34020ca44d0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "394732b5-3fbe-4808-b208-d4b145c98eb0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b5475ba1-d00f-43de-9f5a-318bd4a855a7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f8c6cc91-4b78-4750-979d-fdabfc7fb8bf", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c9e4732-79a7-4c08-a989-2d4884986f58", + "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": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "40a2fce3-a42a-49be-a8a8-adc1dc76ae65", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-change-status", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "password-dictionary", + "description": "", + "item": [ + { + "id": "468764e6-a749-4d31-af72-d17702ff274b", + "name": "Get Password Dictionary", + "request": { + "name": "Get Password Dictionary", + "description": { + "content": "This gets password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/plain" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "983c7055-21b1-4320-9d0a-944defe2f066", + "name": "\nThe password dictionary file can contain lines that are:\n1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing\n2. empty lines\n3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines\n4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;\n maximum length of the line is 128 Unicode codepoints\n\n\nPassword dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).\n Password dict file must contain UTF-8 characters only.\n\n# Sample password text file\n\n```\n\n# Password dictionary small test file\n\nlocale=en_US\n\n# Password dictionary prohibited words\n\nqwerty\nabcd\naaaaa\npassword\nqazxsws\n\n```", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/plain" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "d302f7eb-ca9f-47aa-920f-1bcdb62d593d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "10edf0b4-1bdd-47f0-9cfc-880387cb85d3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a00d4a43-c7ac-4aa3-b0e7-0aa84dad3341", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1b01d8f-7703-4425-bdd0-863482923824", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1dce681-4e41-4cf8-9cad-c7b5b5828844", + "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": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1b2aa53-9ff1-449c-a170-28e0eca7230b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f4cd1894-fa3d-4930-9c77-8ecaeba13258", + "name": "Update Password Dictionary", + "request": { + "name": "Update Password Dictionary", + "description": { + "content": "This updates password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "b35eca7f-d051-41fb-acad-63e774d26297", + "name": "Successfully updated.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "8d890ee1-27d4-41e4-b9c2-58cc40bffd6d", + "name": "Created.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Created", + "code": 201, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "8121d829-d9d0-4f6a-871e-5c96bd6ae540", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24d0e209-4afa-4f80-80a7-690d6f893a4c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf362428-ea65-47cb-95d1-f3d598f5467a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "285baee8-ebb2-413a-98b2-e4b6ac12667c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a887b79c-e82c-4af0-b6ec-6ce5a0f0f485", + "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": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc83486a-a7e2-4242-b55c-ffc9371ecf93", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-dictionary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "password-org-config", + "description": "", + "item": [ + { + "id": "6719e04a-873e-4981-b7d5-dce2615160c0", + "name": "Get Password Org Config", + "request": { + "name": "Get Password Org Config", + "description": { + "content": "This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'", + "type": "text/plain" + }, + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "74d8606d-aa01-4583-af19-7637e2997916", + "name": "Reference to the password org config.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c84ef4f5-351f-4707-8669-efd879c70da4", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc7659d2-40de-403c-b0d2-05787a41eff1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e3d4c0c6-24df-4961-a689-6c1780c46848", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "198294ef-ac6a-4c76-aad4-80306894aed8", + "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": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d66a97e8-feca-4d10-8e13-25f3972c3c07", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "3e0fd573-7eb4-4571-9e6f-4734746d0148", + "name": "Update Password Org Config", + "request": { + "name": "Update Password Org Config", + "description": { + "content": "This API updates the password org config for specified fields. Other fields will keep original value.\nYou must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. \nRequires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'", + "type": "text/plain" + }, + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "0150199d-ae5d-49fb-b603-5155fd439ac0", + "name": "Reference to the password org config.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c749539-2555-4456-9f00-53281eb500a0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5bfd57f-f7ac-4171-b649-541b554891b5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4385f9b4-e835-4477-b33d-a83525149ceb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17f89a12-5f6a-41a1-87cc-3e97378531d2", + "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": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4308f738-4d4a-4e71-9d09-1bd8737909a6", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "23f1b372-f701-4d36-86fd-6d3c05d5143e", + "name": "Create Password Org Config", + "request": { + "name": "Create Password Org Config", + "description": { + "content": "This API creates the password org config. Unspecified fields will use default value.\nTo be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\".\nRequires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'", + "type": "text/plain" + }, + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "7418b307-b1ce-4687-877c-ad30f14f8123", + "name": "Reference to the password org config.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "283d0d82-9da7-47e9-a9a0-eaac1b6d07b1", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26916432-f3bc-4995-825d-923e0bc9c10f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0f0ef16b-bbee-4253-b6a1-360b89c9ff7f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c24aa961-3a38-48b9-85ca-7c7d400c5aaf", + "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": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1a4f4af5-3d69-4d46-8d71-db2bba38073e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "password-org-config" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"customInstructionsEnabled\": false,\n \"digitTokenEnabled\": false,\n \"digitTokenDurationMinutes\": 5,\n \"digitTokenLength\": 6\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "sod-policies", + "description": "", + "item": [ + { + "id": "e65aa9c3-0b03-4361-92d8-6c566dcb3ef8", + "name": "Create SOD policy", + "request": { + "name": "Create SOD policy", + "description": { + "content": "This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "993960ec-d258-4d9e-b9f0-adee1891bbb0", + "name": "SOD policy created", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b7c9a94-45ad-4225-a29f-2040106390f2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32c443a7-8053-4408-b9ef-e19495b4cb0f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "935a1cb2-f7ba-4ed4-a1dc-4b4908f3e9d3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec071959-b2bc-4865-8224-25a2c7800d38", + "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": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9da0bf2-bd9a-457f-9e1e-622debfb2625", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "58ffca58-1a32-48b7-baf2-0dad3e914432", + "name": "List SOD policies", + "request": { + "name": "List SOD policies", + "description": { + "content": "This gets list of all SOD policies.\nRequires role of ORG_ADMIN", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**name**: *eq*\n\n**state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "2efa8e95-875e-4818-bb76-b2869ca4b7ff", + "name": "List of all SOD policies.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**name**: *eq*\n\n**state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"NOT_ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"STATIC\",\n \"ownerRef\": {\n \"type\": \"APPLICATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8c39664d-20a9-4a84-a7ea-c7bb88701c12", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**name**: *eq*\n\n**state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75a1bb20-06cf-4f60-af8b-6a9473ec234b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**name**: *eq*\n\n**state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d67b92c6-18b3-4a55-a6a4-8927f3d7b413", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**name**: *eq*\n\n**state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e91e6a4c-add5-4396-b510-b0e3b07b3ddd", + "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": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**name**: *eq*\n\n**state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "608d675f-b419-4a57-80a8-1f2b2c64352a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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*\n\n**name**: *eq*\n\n**state**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "d5759430-7022-4822-a03d-bba32e60c6bd", + "name": "Get SOD policy by ID", + "request": { + "name": "Get SOD policy by ID", + "description": { + "content": "This gets specified SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6f61a3d7-b1aa-4dd7-915f-85736223fe40", + "name": "SOD policy ID.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f557805a-30e2-4f5b-8c31-e2791fa26509", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b9df656-32ac-417d-be3f-21f73205f1bd", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "edf0a44e-f211-4e15-b10f-cdb076b046e1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e40037e-297d-4bdc-92e9-48f556b86680", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63e12fb0-5b74-4e1a-aea3-7b15cb627003", + "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": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "158eec6f-2ec2-4ea8-9e78-9f870f6b1cb2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f095ff2f-fe33-4f04-b591-615661c98ef3", + "name": "Update SOD policy by ID", + "request": { + "name": "Update SOD policy by ID", + "description": { + "content": "This updates a specified SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "12883afd-cfd9-4dcc-a054-b40c14baf3d9", + "name": "SOD Policy by ID", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a8611c31-c9e9-41ce-8ac5-41521e9b98fb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6688af02-f683-435d-95c9-a5185b283d5f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e187b007-f706-4c8f-a536-2b79a548e020", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff963519-19f4-4ed2-b739-4478d353131b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6fbe7c4b-4f4d-4c7f-9907-27f7d90d8b9c", + "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": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9025ebfa-15f8-4267-953a-8b4de7bef32c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "18a9b895-f538-408e-a608-99131ac38078", + "name": "Delete SOD policy by ID", + "request": { + "name": "Delete SOD policy by ID", + "description": { + "content": "This deletes a specified SOD policy.\nRequires role of ORG_ADMIN.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "b7c24098-ad5a-43f4-ad93-cee29d33e195", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "d3f40ddb-4fdc-452e-8c1a-ec7398298d56", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "991926ff-4e0e-401e-bf76-3a63a3ab853b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "309dc07f-b3a6-4be7-a7d7-ef1db7ca193d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38d6d310-ce88-46f0-a56a-dc29500522b9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "78df32c8-a19d-4c11-9fc8-74a7e5bf2589", + "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": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bfe3b5f2-2a4e-4ff1-bc9d-7254d94fb227", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.", + "type": "text/plain" + }, + "key": "logical", + "value": "true" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "10caf82a-15dd-4ad3-bac0-e669670d2518", + "name": "Patch SOD policy by ID", + "request": { + "name": "Patch SOD policy by ID", + "description": { + "content": "Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nRequires role of ORG_ADMIN.\nThis endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. ", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "562c8c42-d6d0-4f81-9998-b457f3c1d58a", + "name": "Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"ownerRef\": {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"externalPolicyReference\": \"\",\n \"policyQuery\": \"\",\n \"compensatingControls\": \"\",\n \"correctionAdvice\": \"\",\n \"state\": \"ENFORCED\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"creatorId\": \"\",\n \"modifierId\": \"\",\n \"violationOwnerAssignmentConfig\": {\n \"assignmentRule\": \"MANAGER\",\n \"ownerRef\": {\n \"type\": \"IDENTITY_PROFILE\",\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"scheduled\": false,\n \"type\": \"GENERAL\",\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"rightCriteria\": {\n \"name\": \"\",\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c551dbfa-8fb4-442c-bc4a-f79c757fb5b6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5c9a398-b777-45fb-b096-4726733dc87f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "09de8c19-c21b-4586-8ddb-f11fd6d69a47", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9b33fad-f073-496d-b4c3-6136a16147c3", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f3725ab9-5c67-41e8-b710-bbdfe3619fdd", + "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": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ec46039-b9ce-4a7b-b2de-bea642c9e4d9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "evaluate", + "description": "", + "item": [ + { + "id": "fa74b272-c642-4552-b982-5876ee667e6c", + "name": "Evaluate one policy by ID", + "request": { + "name": "Evaluate one policy by ID", + "description": { + "content": "Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "evaluate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "5922cfe5-55bd-4f39-bc72-25207cad776d", + "name": "Reference to the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "evaluate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PENDING\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9997d76a-19e4-405e-a61f-a8e09c081241", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "evaluate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1c45da4c-a472-4002-85a9-be51f3600c51", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "evaluate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "46ecb213-9b02-461b-936b-1536796c7ace", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "evaluate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c16fd7ab-69c9-47ae-9d2f-0bdafbc7469c", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "evaluate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "331a9487-b25d-4a3e-b98e-9934fa2efdcb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "evaluate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "schedule", + "description": "", + "item": [ + { + "id": "98f0da8d-7dfb-437d-92c2-7477d7dfa75d", + "name": "Get SOD policy schedule", + "request": { + "name": "Get SOD policy schedule", + "description": { + "content": "This endpoint gets a specified SOD policy's schedule.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9dd525cc-08a6-46f5-b046-22afb8f0fa39", + "name": "SOD policy schedule.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cdebbdd8-a835-4cd9-a66b-479eacdb9af0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a4c998af-bd48-429d-8c28-c8ba9232453d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "380af1df-630e-4db5-bf8a-e3009ada9491", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "63bb5f32-c4ed-4ac0-b586-f99d4b46a255", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a71b40e-ee23-4d9d-a595-11f2d47ae7c9", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "44a421c5-baf2-4eab-9af9-f5460d4f6c85", + "name": "Update SOD Policy schedule", + "request": { + "name": "Update SOD Policy schedule", + "description": { + "content": "This updates schedule for a specified SOD policy.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2bf011b2-1452-467c-8361-cfd89ecfd602", + "name": "Created or updated SOD policy schedule.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbf48acb-6fa7-487f-88d2-ac1c680e9404", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec45c93a-4c76-4585-b79d-5f0cd2d305e2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "65827ae0-85b8-4190-a096-94caaf9d0f34", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c8b206b-e377-40cd-b3d9-9be00cd71433", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "322621be-237e-4f8d-8b1c-b2375255fb93", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"schedule\": {\n \"type\": \"CALENDAR\",\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"days\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"\",\n \"\"\n ],\n \"interval\": \"\"\n },\n \"expiration\": \"\",\n \"timeZoneId\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"ACCOUNT_ACTIVITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"SOD_VIOLATION\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"\",\n \"modifierId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4f742f65-e156-43df-b327-0e4d3048d1a5", + "name": "Delete SOD policy schedule", + "request": { + "name": "Delete SOD policy schedule", + "description": { + "content": "This deletes schedule for a specified SOD policy by ID.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "86073de4-c65d-44b6-aef8-7b7dc2cd15fc", + "name": "No content response.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "357511f2-c273-438e-8b5d-105a627e733d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e8598e8-062e-4265-bd03-95085d5d16bb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a135a2a-0cb0-4638-a871-7c136337ef75", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d5bbf83-2abe-4351-9a83-22338102a18c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ca5f4d0-a939-4b5a-81db-09de3826412b", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0cb71f9-4720-4309-8838-407eeb1c47ac", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "schedule" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "violation-report", + "description": "", + "item": [ + { + "name": "run", + "description": "", + "item": [ + { + "id": "b94601c2-79a0-4802-b007-e85f8c768d9f", + "name": "Runs SOD policy violation report", + "request": { + "name": "Runs SOD policy violation report", + "description": { + "content": "This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "64bd792e-c219-4509-845c-8c6a05ac1767", + "name": "Reference to the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PENDING\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b1b69bd-7df7-4bef-bd1b-9ac3afdb64a3", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d06cb1ce-a4ce-402a-9e7c-d4f61ffd0281", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2a7099ba-b02d-466c-8f7f-2710991916ef", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "259fd7e6-e579-4024-a546-98af294fba4d", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b0a862c-5a19-40b4-817a-09f8893b4676", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b55a6826-b47a-4104-b97c-e3eafea18d5e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "id": "5a79a367-c2ca-4c08-b7bb-142f6b1e1b5d", + "name": "Get SOD violation report status", + "request": { + "name": "Get SOD violation report status", + "description": { + "content": "This gets the status for a violation report run task that has already been invoked.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1d675a2d-b4fe-407b-a11f-df969a9e3371", + "name": "Status of the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PENDING\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e48f3a8a-49b0-4238-a74e-756e01fe210e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "67d4cd22-6bf1-4046-9633-6a26109b65f8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf1054c0-b90e-4af1-854c-ee084fc73d32", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc697705-d31d-45d5-88cc-cf9cea5cdb6e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae73f0dd-758f-49d1-8c1e-89a443c98822", + "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": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3f602276-e4a7-467a-9699-f53327718167", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + ":id", + "violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "sod-violation-report-status", + "description": "", + "item": [ + { + "name": "{reportResultId}", + "description": "", + "item": [ + { + "id": "7d6d2af1-fcf5-4e9f-b61f-a468c12f521a", + "name": "Get violation report run status", + "request": { + "name": "Get violation report run status", + "description": { + "content": "This gets the status for a violation report run task that has already been invoked.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "reportResultId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "1639c8d0-c5f0-4116-b8ca-a87aa5eed02f", + "name": "Status of the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PENDING\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95d46aa8-f8b5-4da4-be98-368d4c77c32a", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7eb6c43-93a0-43c2-84ed-255fecd317a1", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "434b29fe-35b8-414b-bf06-3ba1d8234c5e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6584c811-5c54-4c6d-ab7a-064a94586766", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "589be67d-04a2-41a5-ae80-2a9b69369667", + "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": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c31bfc50-92ab-4d96-b09d-75db51e58579", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-policies", + "sod-violation-report-status", + ":reportResultId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "sod-violations", + "description": "", + "item": [ + { + "name": "predict", + "description": "", + "item": [ + { + "id": "28a2ed63-1bf8-4802-98b6-eb59f03e436b", + "name": "Predict SOD violations for identity.", + "request": { + "name": "Predict SOD violations for identity.", + "description": { + "content": "This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.\n\nA token with ORG_ADMIN or API authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b93a8a58-2125-4fd1-8402-c2ab56cb149f", + "name": "Violation Contexts", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": false\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": false\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": false\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": false\n }\n ]\n }\n }\n },\n {\n \"policy\": {\n \"type\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": false\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": false\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": false\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\",\n \"existing\": false\n }\n ]\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a152a8e2-2a75-4524-ac4c-d76e981d96aa", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45dcdb14-2d61-4095-9df8-0d7cf0293c62", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c1f91142-42d0-49b6-a77f-635d76a0607f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "abbb0055-4b23-440a-af9f-d3df497d2fa1", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "493d29de-be8c-46d3-bf4d-c6c22c201bbe", + "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": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aba0b347-94f6-43e8-a881-23d3b463ebe7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "predict" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "check", + "description": "", + "item": [ + { + "id": "129f8426-eb96-4219-890e-1d24757771a4", + "name": "Check SOD violations", + "request": { + "name": "Check SOD violations", + "description": { + "content": "This API initiates a SOD policy verification asynchronously.\n\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violations", + "check" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"laborisb\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "d6cdb011-1342-4a47-b77e-e5c71ed8f0fc", + "name": "Request ID with a timestamp.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "check" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"laborisb\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"requestId\": \"\",\n \"created\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d94e1051-fa20-483f-be31-74941cfd8c2d", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "check" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"laborisb\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36ca0111-1257-492a-829e-6e393bba5d53", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "check" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"laborisb\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42df6cf5-aa08-408d-b4a1-daf6959d5a2c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "check" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"laborisb\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bf791e92-0509-46eb-a690-8f1bdf28e0b0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "check" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"laborisb\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "baefaba1-81bd-4812-80d0-e59bba77d870", + "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": { + "url": { + "path": [ + "sod-violations", + "check" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"laborisb\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6957fc42-b583-4ccc-b1e0-974117c62ca8", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violations", + "check" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"identityId\": \"\",\n \"accessRefs\": [\n {\n \"type\": \"WORKGROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"clientMetadata\": {\n \"laborisb\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "sod-violation-report", + "description": "", + "item": [ + { + "name": "run", + "description": "", + "item": [ + { + "id": "e8cda3e1-fc45-43e5-8a61-a1be3455d2db", + "name": "Runs all policies for org", + "request": { + "name": "Runs all policies for org", + "description": { + "content": "Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "ab5810eb-39b5-44c4-8001-a29294a8bd23", + "name": "Reference to the violation report run task.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PENDING\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81ae7f75-6f94-4d11-b441-c7401932bc36", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "17bf1b00-cddf-4438-9155-81fc0b6c144b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e1218eb-49e2-44f0-973b-1534500074e4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3960fc93-74bc-4aa8-b9a2-cbbe547587b4", + "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": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa8f69d9-afd8-40a6-bff3-2c6cceae8839", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"filteredPolicyList\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "id": "2308a8a2-071d-42c3-b1fb-e0f3649625be", + "name": "Get multi-report run task status", + "request": { + "name": "Get multi-report run task status", + "description": { + "content": "This endpoint gets the status for a violation report for all policy run.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "2a200b7a-5ff9-417b-b8fd-47c10a9cbea9", + "name": "Status of the violation report run task for all policy run.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"ACCESS_REQUEST_APPROVAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PENDING\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "be0a28e8-6f47-4b6e-878c-1f0586e4e870", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4e7a9869-0338-4f95-9c05-9a313fa1ff02", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a898b0ad-f849-4554-be27-52ac85d16f0a", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "72dabe85-6fe4-413e-a0f7-2e588faa3b5d", + "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": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36d3360f-5f7c-4881-9512-1eea1e5b2ab5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{reportResultId}", + "description": "", + "item": [ + { + "name": "download", + "description": "", + "item": [ + { + "id": "9860509d-4edf-4b92-a943-558740603744", + "name": "Download violation report", + "request": { + "name": "Download violation report", + "description": { + "content": "This allows to download a violation report for a given report reference.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "reportResultId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "0ef948a8-4e38-4e4e-a293-a2a3cd7d2dc2", + "name": "Returns the PolicyReport.zip that contains the violation report file.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "9881f13d-f4eb-4280-ba38-ffbe27a468c9", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a08b5ad-5d1a-49e9-9bd2-bae3133283eb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ece114d-bdba-4871-a536-cf5a87a00f20", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6fd5bf65-eb2d-4709-93e1-7d92c5567629", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f39b51fa-6286-43ae-b9df-665b85618b00", + "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": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ffb0386a-43db-4dda-8a36-2e600c92fc53", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{fileName}", + "description": "", + "item": [ + { + "id": "d709dd8e-ca8d-491b-9b3c-df7edb0c48c5", + "name": "Download custom violation report", + "request": { + "name": "Download custom violation report", + "description": { + "content": "This allows to download a specified named violation report for a given report reference.", + "type": "text/plain" + }, + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "reportResultId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "fileName", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4be77644-030c-4255-bee8-659ff7e11790", + "name": "Returns the zip file with given custom name that contains the violation report file.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/zip" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + } + ], + "body": "", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "e0c7e993-5cd4-45c2-b023-a8f7d7db121f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bdabc066-10ad-4243-ad66-4e1820b6431e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31e07b7c-7107-49e7-8568-ee32f152e328", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a528862e-5467-4dab-9034-476ad652a223", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a3f4ee1-5be5-4d3a-bde3-40c23f316801", + "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": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0154764-dd61-4444-a78f-aa514bc0e3a7", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sod-violation-report", + ":reportResultId", + "download", + ":fileName" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "sources", + "description": "", + "item": [ + { + "id": "f7a21e40-5233-4c3f-8330-c243a9d51451", + "name": "Lists all sources in IdentityNow.", + "request": { + "name": "Lists all sources in IdentityNow.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "6c4f92a0-9b5e-4c55-893f-9c32284eeef7", + "name": "List of Source objects", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"GROUPS_HAVE_MEMBERS\",\n \"ENABLE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n },\n {\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"GROUP_PROVISIONING\",\n \"COMPOSITE\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1fb2f77b-88fb-4467-ad98-08bc522a7418", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32836249-4a30-4e8f-a8a4-2b6b7bd410df", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f37b00e8-3bb8-45b7-a2f8-46b8e383b30c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b44b95d-4e88-49fe-b507-541d7a990708", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "60c816e4-1d84-43a5-9c8c-bba6c267bda4", + "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": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "64c68a54-b67c-4e90-bed0-92548870c679", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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 **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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**", + "type": "text/plain" + }, + "key": "sorters", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "for-subadmin", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2aab6884-98e9-411c-aa84-89f88eb36ed2", + "name": "Creates a source in IdentityNow.", + "request": { + "name": "Creates a source in IdentityNow.", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "1a24d788-1853-4a1f-8352-fca03c2c4525", + "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": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf92c927-f70d-4625-b824-bf188c3b42a5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c46048af-7364-4596-af03-268fe06ce825", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "753002bb-16a9-49fc-9369-af85f1bfd37d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9369c4c4-3b92-4a0f-872b-76a804544012", + "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": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4df78c9b-6b36-4827-a714-80789881d9f5", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ", + "type": "text/plain" + }, + "key": "provisionAsCsv", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "fef6f348-c9a7-4bed-9fde-a6d397dd07c1", + "name": "Get Source by ID", + "request": { + "name": "Get Source by ID", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "82a03a08-436b-4f1a-b7b0-be7a94c00e2b", + "name": "A Source object", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d7ce9b7-7bec-4a87-8b9c-314b78d31757", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fc89ff65-8cad-4d07-a075-a5745a98e5dd", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1cb2bbc4-e505-4edf-b43b-18197146ba02", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9da7b5d-b59a-439b-951c-2f2821044865", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4633d7f3-0e37-4499-ab51-9dde13f01a0f", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "14b3a3b7-40cc-49ae-9074-0634536eae75", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "32655f78-7d82-4066-874d-bfdb90dae189", + "name": "Update Source (Full)", + "request": { + "name": "Update Source (Full)", + "description": { + "content": "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", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "e07cd991-d70f-4030-9f71-1976c314b932", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "441d954d-65b7-4cde-887b-4e6c36801c78", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a8236608-a62a-4176-be61-6a12bce889ee", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c56208cc-53b8-4c6f-8efa-cad76f7ccfaf", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0cc247e4-4162-4328-bb0c-2aa80edb141e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "447ce460-183c-467c-ba6b-c9d0454da74c", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6ce90b7-0d71-44cf-8b65-5a739a185fa2", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "3c2574d3-e2fa-475d-a947-0175e821c0cd", + "name": "Update Source (Partial)", + "request": { + "name": "Update Source (Partial)", + "description": { + "content": "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", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "60550547-c47c-44ea-b4df-ddfe28f9953a", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "080abea0-f7cb-4007-8b30-307975590946", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5a9685d7-092f-4445-acb3-09c315d36f86", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ce4ebcc9-8041-493f-b3e2-dc0ced97442f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "263411ae-f123-473e-9bd1-eda4dcd44a70", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e10178d0-00be-485b-9a1f-778762dfadb8", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "599990e4-eb90-4089-91c7-5fcf2179cd14", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a5e02c6e-298d-427b-b9ba-5cfae686b365", + "name": "Delete Source by ID", + "request": { + "name": "Delete Source by ID", + "description": { + "content": "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}`", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "65b912e4-2299-4d37-b542-4b3176973f20", + "name": "Accepted - Returned if the request was successfully accepted into the system.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Accepted", + "code": 202, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"TASK_RESULT\",\n \"id\": \"\",\n \"name\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3941767d-ed1b-42c2-9ea6-c7bebcf43319", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "546231dd-c382-4121-be3a-afbc6827656c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "00df91ad-e281-4284-99a4-b4ddec871fb7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4cb00e65-a476-4a66-9693-6926dd2bbf20", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0a406cf2-836d-4e04-9672-5610842d5349", + "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": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbf90fde-13cd-4930-a742-a76fd973b4ef", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "schemas", + "description": "", + "item": [ + { + "name": "accounts", + "description": "", + "item": [ + { + "id": "7cecb93a-538b-4a4e-9c2e-a4e7e518fefe", + "name": "Downloads source accounts schema template", + "request": { + "name": "Downloads source accounts schema template", + "description": { + "content": "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.**", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "da22b0ea-d8cd-4860-b9cc-661dad0da166", + "name": "Successfully downloaded the file", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{\n \"example\": \"id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate\"\n}", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "72921db5-6ee4-4801-99f2-1ed8a295b135", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6e667458-186a-4b03-8f11-df0784494643", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5b8f97ef-d552-46d8-af2e-5aa5290b22a9", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31ace5e7-aa43-4614-9242-d15c687c72b8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26519690-86d2-4a2e-9512-90eeaccf3497", + "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": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96c4c67a-23f2-437e-af15-d00fc0079726", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "7a72a2c0-b779-4847-912a-f554d0fc92b3", + "name": "Uploads source accounts schema template", + "request": { + "name": "Uploads source accounts schema template", + "description": { + "content": "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** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema**\n\n>**NOTE: This API is designated only for Delimited File sources.**", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "d796f492-01c2-4a55-a498-65d7f101d56f", + "name": "Successfully uploaded the file", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75abab3a-52ee-425f-a114-dacbf35c8056", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b7f3360-4588-4cf6-a5d3-94395b461503", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "81cbf5b2-f6ef-44b2-bc9b-774035c7c15b", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d99dcf37-2f87-4200-813e-967180015464", + "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": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "82f17936-1cd3-4d74-b680-f6b6ae3ec8ee", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "entitlements", + "description": "", + "item": [ + { + "id": "8c7f33c4-d42f-4f24-83d6-f551d4da7e92", + "name": "Downloads source entitlements schema template", + "request": { + "name": "Downloads source entitlements schema template", + "description": { + "content": "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.**", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "a6095ecc-ddf2-4f2d-9b8d-f782b8938676", + "name": "Successfully downloaded the file", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{\n \"example\": \"id,name,displayName,created,description,modified,entitlements,groups,permissions\"\n}", + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "d5aaca50-3f81-48a6-a0c7-68ef386a7fcf", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26eb8d9c-ebe7-4955-bc18-115342006fa2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d6f66580-b398-4ce3-b54e-57c929a70297", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "73035aeb-d05d-4986-9ab9-8546d4392eb1", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6e8fc3c7-39de-4b48-848f-9368d5a76938", + "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": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42ba9c40-ffe1-40fe-affe-42902206058c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "07fb78fd-cc6e-4575-ab56-f787ca9f1dbf", + "name": "Uploads source entitlements schema template", + "request": { + "name": "Uploads source entitlements schema template", + "description": { + "content": "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** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download**\n\n>**NOTE: This API is designated only for Delimited File sources.**", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "0fe54b9b-8376-4d46-8859-43cd0390fe5a", + "name": "Successfully uploaded the file", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f6044b9a-b6c0-4130-900f-40c4c2861e51", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fbe69130-78e8-4785-ab47-0c8f79eab3e8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d46dfc45-d78a-4225-aba3-8c4bbae2fbf1", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89edec31-e2eb-484c-8aeb-43bda09da9e6", + "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": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95677c7b-3a8f-4721-8ab8-eae15016c65f", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":id", + "schemas", + "entitlements" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Name of entitlement schema", + "type": "text/plain" + }, + "key": "schemaName", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "{sourceId}", + "description": "", + "item": [ + { + "name": "provisioning-policies", + "description": "", + "item": [ + { + "id": "d2d1e2b5-9921-4ce7-856f-e14235e05c04", + "name": "Lists ProvisioningPolicies", + "request": { + "name": "Lists ProvisioningPolicies", + "description": { + "content": "This end-point lists all the ProvisioningPolicies in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4c6cc81a-9788-4a18-b27b-9e2a45c49f55", + "name": "List of ProvisioningPolicyDto objects", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f4040ec1-6aa1-40a3-849f-d57c28a494da", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4221f13b-c4a5-4bff-bcf3-69bd7c835007", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "36673af4-9289-4fd1-a5b9-3e44d3be4da6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7df26f56-0015-4ab5-8bb8-ac039991fea7", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "616453c0-7a55-46aa-b544-f1aae80ef809", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0bc0e344-e1bf-4f6a-b312-58831d2bf30a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "493c6ef0-6265-4277-a4b3-e2a43fdcf248", + "name": "Create Provisioning Policy", + "request": { + "name": "Create Provisioning Policy", + "description": { + "content": "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.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with ORG_ADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "08fa75a9-b9cd-4b9b-b1eb-c865b49ab1b1", + "name": "Created ProvisioningPolicyDto object", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6d44356-03ba-454b-9b4f-214a8e2293fc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1788d306-794e-4f0a-93f1-fb4d09bafcf0", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec6e51ae-8b02-4600-a984-a3f7cc684be7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ce6d9df6-1346-49a0-adfc-ef272f0180e0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0890724-acb0-4c70-8863-d1ffb7829e71", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f87560b8-dac9-4c6b-b40b-f36effb305cd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{usageType}", + "description": "", + "item": [ + { + "id": "5c92f076-dbd2-40e7-b54a-5addc36c7faf", + "name": "Get Provisioning Policy by UsageType", + "request": { + "name": "Get Provisioning Policy by UsageType", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "CREATE", + "key": "usageType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4fe2e9f0-fd34-4794-9575-1a7e4cb27cba", + "name": "The requested ProvisioningPolicyDto was successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f2d3d7d4-b08f-4c5f-b108-764763a92c16", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "87a9a6b8-ab1c-4f5f-b22f-57e50bbe5427", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5843e134-fed4-4131-9088-9836cc36807c", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "68623d7a-a226-42a4-94d5-ed4912381491", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f557e68-7e52-4406-b3f5-9228b999d83d", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0fe6e701-36dc-41c0-b173-47cbf2cadade", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "4f10cdc3-495c-4cdb-b756-03c116eea361", + "name": "Update Provisioning Policy by UsageType", + "request": { + "name": "Update Provisioning Policy by UsageType", + "description": { + "content": "This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "CREATE", + "key": "usageType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "538b790a-c50f-4c4b-bde6-e114c3725335", + "name": "The ProvisioningPolicyDto was successfully replaced.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74247eaa-9f4d-417f-b775-268da1ae65e2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a53598aa-75e0-44b3-8aae-f78b343906a8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cfc814c8-4ef1-419b-b198-3e991940b2e3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "58abd168-527d-49bd-81d9-9dce311a6816", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a1d6e2db-0625-4ba7-9f8c-c50d40cfbfd9", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2e4171f0-50ec-4994-bedf-101628c26523", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f4bdb424-6b32-45c6-be36-57021b0f8405", + "name": "Partial update of Provisioning Policy", + "request": { + "name": "Partial update of Provisioning Policy", + "description": { + "content": "This API selectively updates an existing Provisioning Policy using a JSONPatch payload.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "CREATE", + "key": "usageType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "eed89873-d7ae-42e4-a1bb-ffec08516b5b", + "name": "The ProvisioningPolicyDto was successfully updated.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"CREATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1218700b-98a6-44d0-82b1-d1647dcf8398", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0813a614-3788-4c0f-9c40-8729afa09a5f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e1e1b592-b857-42a6-8b03-44ea4f76aebc", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a3f14280-f4b1-4849-9a70-d43e34fb34df", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a58c8ec-9e95-473b-982b-5a5d73ecffce", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1d6035e-ccd5-4d75-b716-f4762c9f7999", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b490c8dc-711c-4306-a712-8adf36fe32f7", + "name": "Delete Provisioning Policy by UsageType", + "request": { + "name": "Delete Provisioning Policy by UsageType", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "CREATE", + "key": "usageType", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "48a34dd9-b99a-4ded-8918-9265b4c49fbf", + "name": "The ProvisioningPolicyDto was successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "99406b90-d627-4345-b1e1-028112b29ac0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3f0febe6-690b-4ecb-ab04-52ace16b1a24", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d2be91c2-788c-4242-9f8d-70eaea2389bb", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "22fb55d8-d85a-4c1f-a62c-56f7034faed0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "226ecc81-e919-4377-86f4-64c7369815d3", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b7b9e67-dab5-492d-a2f9-e91635eeece4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + ":usageType" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "bulk-update", + "description": "", + "item": [ + { + "id": "aa6224f2-3720-46f7-8422-42dbaa5ea129", + "name": "Bulk Update Provisioning Policies", + "request": { + "name": "Bulk Update Provisioning Policies", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "66a35dc3-ace2-4dec-96e1-360e58b459cb", + "name": "A list of the ProvisioningPolicyDto was successfully replaced.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "710f5ee1-2fc5-465d-8f19-e34c90575d17", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4b9e6010-0679-4483-9de3-6ff79c9becd5", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "286e67e6-289b-4799-88ba-0e89398930de", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5ccb57ed-750e-4706-a85b-3fb4db4e081b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dca58ee5-7b12-45bd-8b61-5011c3c8c66a", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "871a935b-d8b2-4683-b260-cb54145020ba", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "provisioning-policies", + "bulk-update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"ENABLE\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"usageType\": \"UPDATE_IDENTITY\",\n \"fields\": [\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n },\n {\n \"name\": \"\",\n \"transform\": {},\n \"attributes\": {},\n \"isRequired\": false,\n \"type\": \"\",\n \"isMultiValued\": false\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "schemas", + "description": "", + "item": [ + { + "id": "6c319dfb-8436-443f-971f-7f65820628f9", + "name": "List Schemas on a Source", + "request": { + "name": "List Schemas on a Source", + "description": { + "content": "Lists the Schemas that exist on the specified Source in IdentityNow.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "3c35f194-aa12-470f-8134-b7d1228315fc", + "name": "The Schemas were successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"DISCOVER_SCHEMA\",\n \"NO_UNSTRUCTURED_TARGETS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"GROUPS_HAVE_MEMBERS\",\n \"UNLOCK\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2548bf3d-89b7-4b8f-b15b-da89957d24eb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8157affc-bf06-468b-aa26-bb1bf3133c49", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "242085d9-1f52-4580-a03b-54a6dd6833da", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "27c5d5a8-86cb-46b3-9d67-3335a7a7f863", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "355990bd-1091-4510-b339-e8ae8fde7f70", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f8a4bb85-eb4f-475b-86fb-4386dee70feb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.", + "type": "text/plain" + }, + "key": "include-types", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "2db96fb5-e3d7-4c0a-80db-e6cdf78636c4", + "name": "Create Schema on a Source", + "request": { + "name": "Create Schema on a Source", + "description": { + "content": "Creates a new Schema on the specified Source in IdentityNow.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a9ac5b46-38db-4934-a931-4987d80fc1bf", + "name": "The Schema was successfully created on the specified Source.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48d03918-f2cf-4a05-8947-1b1d516ba28b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "85e6b72b-b899-483c-90ad-ba26658071eb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a5e90bf-444d-42d9-b652-6d671c943eb3", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "70981c96-0d2f-452f-a89f-280dcb1267f0", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5ade36c-1760-4d8d-bb4e-88026422ccd4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{schemaId}", + "description": "", + "item": [ + { + "id": "3e97693f-cd57-4763-a6eb-0ac65609022e", + "name": "Get Source Schema by ID", + "request": { + "name": "Get Source Schema by ID", + "description": { + "content": "Get the Source Schema by ID in IdentityNow.\n", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "schemaId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "d5dffb62-316e-4d50-b903-5c847d6f543f", + "name": "The requested Schema was successfully retrieved.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "078422ee-1243-45d2-9e64-9c6f5db5c795", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "19ec4f12-7ee9-4a3f-9f16-c325953c6572", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7780106c-a5b5-4ccd-9c09-b43be204a745", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "18aae2e4-b4ac-4162-b305-41e75fc34a7e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5caff58b-b5c8-4972-886b-214475479f7a", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0252e6d2-5b4c-4bbe-8cb1-2bdc4dc418cb", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d0571959-ab8b-4603-a0bb-85ba9dd7f4ca", + "name": "Update Source Schema (Full)", + "request": { + "name": "Update Source Schema (Full)", + "description": { + "content": "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", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "schemaId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "061920f4-526a-4cd0-85ee-c17955c0f4aa", + "name": "The Schema was successfully replaced.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "09bc5734-dadb-40ef-b3e8-2d9686fe9e33", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e8f271bf-c92c-4827-8ac4-c6f72746e63e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "064c4b31-7110-4605-ad7e-33c1239f667e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa212583-2d01-4b1d-8f89-de46ed77cf75", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c43fad60-9335-43a3-8247-dfaa3770d679", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "33c5d178-34cc-4dd3-8f77-a540896ce748", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "55b29b3d-4486-4c51-975a-c3ef348b40c8", + "name": "Update Source Schema (Partial)", + "request": { + "name": "Update Source Schema (Partial)", + "description": { + "content": "Use this API to selectively update an existing Schema using a JSONPatch payload. \n\nThe following schema fields are immutable and cannot be updated:\n\n- id\n- name\n- created\n- modified\n\n\nTo switch an account attribute to a group entitlement, you need to have the following in place:\n\n- `isEntitlement: true`\n- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:\n```json\n{\n \"name\": \"groups\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180887671ff8c01767b4671fc7d60\",\n \"name\": \"group\"\n },\n \"description\": \"The groups, roles etc. that reference account group objects\",\n \"isMulti\": true,\n \"isEntitlement\": true,\n \"isGroup\": true\n}\n```\n", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "schemaId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "2ef4ea3c-42d6-4f38-9a96-71aff891cbc1", + "name": "The Schema was successfully updated.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"nativeObjectType\": \"\",\n \"identityAttribute\": \"\",\n \"displayAttribute\": \"\",\n \"hierarchyAttribute\": \"\",\n \"includePermissions\": \"\",\n \"features\": [\n \"UNLOCK\",\n \"NO_GROUP_PERMISSIONS_PROVISIONING\"\n ],\n \"configuration\": {},\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"BOOLEAN\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"description\": \"\",\n \"isMultiValued\": \"\",\n \"isEntitlement\": \"\",\n \"isGroup\": \"\"\n }\n ],\n \"created\": \"\",\n \"modified\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2d878fca-7fdc-4ed5-a459-397b1f2dbca2", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d7bb5268-72a0-4039-9516-1cdebd5e7806", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5d7f40a-ee2c-4313-bc5b-5db540933fc2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2f51b19f-9690-48f5-b8dc-6522bb6a6e54", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e420e6d5-83e2-41f6-9565-f9bd5a53ee5d", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "52d8032a-59f0-4b27-8cc6-dadd3e3ebf3b", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"copy\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9752cd83-192a-4a02-976c-6919fe81d1e2", + "name": "Delete Source Schema by ID", + "request": { + "name": "Delete Source Schema by ID", + "description": {}, + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "schemaId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "199707c2-1818-4394-a8ce-d0a0923c0bc7", + "name": "The Schema was successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "d55454da-4db7-4510-ad2e-0e79cc77fb02", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45c1ebdd-1ac5-4f35-aa77-008f6ea8cb85", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6172480e-5462-4b20-a4aa-d0c87bdc0fa4", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fd8f0aba-4d41-4d35-b05f-77bf44549cfb", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cbb4ec8a-3914-4875-bb7c-50562a7bf443", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b6e5c65-fe30-46b3-b637-8b465ad21b4c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "schemas", + ":schemaId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "source-health", + "description": "", + "item": [ + { + "id": "454e5f18-25c2-497e-be35-5bd2f1c5744e", + "name": "Fetches source health by id", + "request": { + "name": "Fetches source health by id", + "description": { + "content": "This endpoint fetches source health by source's id", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "source-health" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "9871973e-a56b-45c7-aa0a-e917c1e3d644", + "name": "Fetched source health successfully", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "source-health" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"org\": \"\",\n \"isAuthoritative\": \"\",\n \"isCluster\": \"\",\n \"hostname\": \"\",\n \"pod\": \"\",\n \"iqServiceVersion\": \"\",\n \"status\": \"SOURCE_STATE_FAILURE_CLUSTER\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "10c08ba3-a92e-4713-bcb0-d59e8f68e270", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "source-health" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0daa9b78-aac6-4544-b537-12628687c37c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "source-health" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "227f6902-a42d-42ac-a640-52f7fd9e8aa6", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "source-health" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "581316a4-826c-4398-9118-136f17ee5247", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "source-health" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6dae39f7-b5c4-453a-a23f-f0bba5c69c77", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "source-health" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "571d3a7f-7340-4594-a14b-95a4fe51fb90", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "source-health" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "upload-connector-file", + "description": "", + "item": [ + { + "id": "233ef048-a5e8-453d-9af8-427aa94146b2", + "name": "Upload connector file to source", + "request": { + "name": "Upload connector file to source", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "sourceId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "response": [ + { + "id": "0660dd6f-4e11-46b7-95ef-40c36d2a00f2", + "name": "Uploaded the file successfully and sent all post-upload events", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"connector\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttribute\": \"\",\n \"identityAttribute\": \"\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"features\": [\n \"ACCOUNT_ONLY_REQUEST\",\n \"SYNC_PROVISIONING\"\n ],\n \"type\": \"\",\n \"connectorClass\": \"\",\n \"connectorAttributes\": {},\n \"deleteThreshold\": \"\",\n \"authoritative\": \"\",\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"healthy\": \"\",\n \"status\": \"\",\n \"since\": \"\",\n \"connectorId\": \"\",\n \"connectorName\": \"\",\n \"connectionType\": \"\",\n \"connectorImplementstionId\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "339b656d-a429-48f3-b2c9-79bb206bec6f", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cd137f24-aa5f-4fb5-9938-40f92037a055", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4070ded-7c11-40cf-a7cb-fddab162cd99", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5805e452-c3ac-4f84-9d43-ecd219c24b20", + "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": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48a630be-7c49-4ee6-b945-ba277ff8dcde", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "sources", + ":sourceId", + "upload-connector-file" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "tagged-objects", + "description": "", + "item": [ + { + "id": "937534d7-c24f-4cb1-af8c-aa4081fa5eab", + "name": "List Tagged Objects", + "request": { + "name": "List Tagged Objects", + "description": { + "content": "This API returns a list of all tagged objects.\n\nAny authenticated token may be used to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "54d1adcf-662b-4490-aafe-5f4083e8ead7", + "name": "List of all tagged objects.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"objectRef\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"objectRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cb1ce49-b6f1-45be-950a-481b03ad03c0", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "45862d58-becc-47ed-8aef-5a3ec7037e7e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f7631faf-f6d2-4d9d-a435-bcc6c4d221b7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "354ba9f4-c4df-46e7-8b58-202173178c78", + "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": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6e1cb98d-f01d-4523-908c-412834586642", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "290ec36a-47d8-4885-b052-1d936d2aef2c", + "name": "Add Tag to Object", + "request": { + "name": "Add Tag to Object", + "description": { + "content": "This adds a tag to an object.\n\nAny authenticated token may be used to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "81e6630f-a65d-4961-86d1-697c2d6ed2e1", + "name": "Created.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "314667ba-c062-40f0-8e4f-632caf46f18e", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4bc44e81-35e4-4e68-b0c7-23a6d717b5ce", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a48c8bc9-476f-4591-a6fe-fde34a3bde23", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1bb41f2a-5442-417b-b0c9-7e6c624534fb", + "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": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b530f92-abba-4237-a727-be97c604d059", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{type}", + "description": "", + "item": [ + { + "id": "50e232c3-ae02-40db-8ea6-c2e4ba9bb0ce", + "name": "List Tagged Objects", + "request": { + "name": "List Tagged Objects", + "description": { + "content": "This API returns a list of all tagged objects by type.\n\nAny authenticated token may be used to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "SOD_POLICY", + "key": "type", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5a46e31a-5448-4512-a83e-6e0de82a381d", + "name": "List of all tagged objects for specified type.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"objectRef\": {\n \"type\": \"RULE\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"objectRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "243636c9-dc4d-4ed8-9713-aeac353450ec", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "394590ff-dc8b-4e9c-888e-e72f1c9369eb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4f64a54-f596-47aa-ae4b-1c85cd0bdd14", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bcd159ad-5493-4b12-955d-49d4e2c03e95", + "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": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d2905015-3235-416a-8b05-249073a1af51", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "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**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "7cecba07-0eed-410a-83a9-f1a3667990f0", + "name": "Get Tagged Object", + "request": { + "name": "Get Tagged Object", + "description": { + "content": "This gets a tagged object for the specified type.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "SOD_POLICY", + "key": "type", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "53528895-cf4a-4dc8-bdf8-018956be14cd", + "name": "Tagged object by type and ID.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7a3c9a4e-b41e-4b5e-a5a2-8efd33cbfda6", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6b692bb0-45f2-44cc-933d-7aa3e0e8b2ef", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "95e8eb81-d934-417a-9fb0-1b8c4349b36d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6514037f-252c-470f-a2f0-f8a45e1992da", + "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": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1dc93c77-1374-4d32-83b6-24d7429c46c8", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "7c026440-8fe5-40fa-aab1-d80b81b24960", + "name": "Update Tagged Object", + "request": { + "name": "Update Tagged Object", + "description": { + "content": "This updates a tagged object for the specified type.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "SOD_POLICY", + "key": "type", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "b746cec3-a7f7-44ce-a1c8-4e3379c25868", + "name": "Tagged object by type and ID.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c7b928e-178f-46ff-bae8-1368a2cac3cc", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ba58e3e2-681a-412e-9727-e0f8958b71ec", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "07e729d0-0e74-47ee-8eed-3af8f6a86dce", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8b3ed18d-900b-47ff-ab87-6cb7cbd2aba4", + "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": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "30dcfedb-c2e2-4006-9df4-b1db04eb7938", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"objectRef\": {\n \"type\": \"CAMPAIGN\",\n \"id\": \"\",\n \"name\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b495e027-be0f-4f62-b611-8437ba79b81d", + "name": "Delete Tagged Object", + "request": { + "name": "Delete Tagged Object", + "description": { + "content": "This deletes a tagged object for the specified type.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "SOD_POLICY", + "key": "type", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "a56bec7f-cbe3-4c77-ae41-79b948999acb", + "name": "No content.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "f0b334f0-9126-4cbf-a9a2-296bd80d7591", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b622ef0b-6083-4f4e-bffd-652d790f5fd8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11315eae-47c4-46e3-b71a-13392d7ee856", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "10048c03-30b0-4c46-94ff-71bd63925192", + "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": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0f421662-3dfd-4e00-8de5-b2b52e7f95ae", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + ":type", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-add", + "description": "", + "item": [ + { + "id": "4614f61b-d5e9-42ff-b70a-713813ee7145", + "name": "Tag Multiple Objects", + "request": { + "name": "Tag Multiple Objects", + "description": { + "content": "This API adds tags to multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "5e5d97d4-8bbc-41eb-a348-de2e20b0590a", + "name": "Request succeeded.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f72eada7-653b-44d0-b020-8996e48f3534", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "159a3e90-2a3f-426d-9bae-b42fe87ac89c", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae7aadc7-e549-4158-942a-9d91f8ea21ec", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "550cf336-48d0-4a95-bbe1-5945776a20ea", + "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": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b773bda-efe9-48be-8dd5-b46481da2d23", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "bulk-remove", + "description": "", + "item": [ + { + "id": "7f2045f9-ecdf-44ce-aa95-e8dd7a3ba83e", + "name": "Remove Tags from Multiple Objects", + "request": { + "name": "Remove Tags from Multiple Objects", + "description": { + "content": "This API removes tags from multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "a5fb1f65-b554-41db-a4b7-8a9dc018a48e", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "a74418de-b126-47bf-a0be-f789b87ca7a5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3aae1ff8-ae71-4041-95f9-cbf6e3134f10", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d3aa8585-55f3-460e-836c-941c02499954", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c10a938f-666c-485c-b04f-c57c3e564fc3", + "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": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f72421dd-0556-471b-ba36-e6880b00ef45", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "tagged-objects", + "bulk-remove" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"objectRefs\": [\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"CLUSTER\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"operation\": \"APPEND\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "transforms", + "description": "", + "item": [ + { + "id": "9f3d3317-8ed1-4108-a7e5-2f1fbce2c56b", + "name": "List transforms", + "request": { + "name": "List transforms", + "description": { + "content": "Gets a list of all saved transform objects.\nA token with transforms-list read authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "e8df4f76-2ed6-47ac-907a-3b7e0d305bf4", + "name": "A list of transforms matching the given criteria.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"name\": \"\",\n \"type\": \"randomAlphaNumeric\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"ullamco_103\": 76298525.39114416\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"dateFormat\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"temporf1\": 17336756,\n \"pariatur062\": \"in aute incididunt\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "565fa62c-1403-4c8c-a004-35fc61b1a708", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e88ee6f-4812-4f56-adaf-917e64f64b3b", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4714fa81-0a81-4eac-bd84-718cc6b26c35", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b1652d36-e162-4264-9979-1d42598641c1", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8e0ef148-64f1-4736-8449-c51e95ea43f0", + "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": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "712f2547-ab3a-4dd2-8fea-ce55e37133fd", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Name of the transform to retrieve from the list.", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "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*", + "type": "text/plain" + }, + "key": "filters", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "07167c82-5505-4dbd-862b-cbc0217a22da", + "name": "Create transform", + "request": { + "name": "Create transform", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "70486243-974e-4157-80e1-7bb8362b823f", + "name": "Indicates the transform was successfully created and returns its representation.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Created", + "code": 201, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0d5c78a2-9490-40ac-91aa-c575d57ce06b", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01d83efe-a703-45d4-926b-761759e63af7", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4bcf24bf-7808-491e-9c2e-b69ba4f58c9e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c30f9e45-57fa-4f33-892d-4d7381ab42a2", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9a28ac7b-b001-4a34-aa99-b255128423d1", + "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": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bfdcbeff-5878-4d5c-8d36-d8f60d333a87", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "b0dab682-f064-48ea-847e-501bc84f2183", + "name": "Transform by ID", + "request": { + "name": "Transform by ID", + "description": { + "content": "This API returns the transform specified by the given ID.\nA token with transform read authority is required to call this API.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "0fa0aa95-c120-42b7-ac37-73c6f20ef50e", + "name": "Transform with the given ID", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f927cf5a-c439-483c-8da2-5ac7c89cec6c", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "87837a38-8b9d-4875-b3be-ebb1836e5aec", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e769a428-af7a-4e71-9c3b-bdd2dac85b38", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5044942e-a05e-4f01-b4c4-2b2303eca54e", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2688ca69-722a-4cba-9413-911062f654b9", + "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": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0530c649-74c2-48fd-9377-a090f74cfec1", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ee407fbd-88d0-4295-91e6-fa650deb319e", + "name": "Update a transform", + "request": { + "name": "Update a transform", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "c3bd274b-2e56-4b6a-be97-f61e0b7d661d", + "name": "Indicates the transform was successfully updated and returns its new representation.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f242d300-11f6-43e1-9425-64fe84a40717", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2ddae5a5-e72f-4745-8613-9be869930826", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9aa1f741-94e5-40af-b62d-1f9b775cc715", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c58a0904-e1d3-4b05-9157-0bc5fc15bf62", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3fdbbf82-d7fb-4169-a016-82ef73b4f9f0", + "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": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "170e3dbf-b277-4121-871f-58eee9aef997", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"type\": \"normalizeNames\",\n \"attributes\": {\n \"sourceName\": \"\",\n \"attributeName\": \"\",\n \"accountSortAttribute\": \"\",\n \"accountSortDescending\": \"\",\n \"accountReturnFirstLink\": \"\",\n \"accountFilter\": \"\",\n \"accountPropertyFilter\": \"\",\n \"requiresPeriodicRefresh\": false,\n \"input\": {\n \"sint8f\": \"nulla dolore sunt esse\"\n }\n },\n \"id\": \"\",\n \"internal\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5f133923-f4ae-42c5-9efc-d2676fe57c33", + "name": "Delete a transform", + "request": { + "name": "Delete a transform", + "description": { + "content": "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.", + "type": "text/plain" + }, + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "response": [ + { + "id": "2cab9a3d-3243-4e96-a0c9-759797068d70", + "name": "No content - indicates the request was successful but there is no content to be returned in the response.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "4d9e5f31-b311-4ed8-8f71-6031a7d46717", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "58fdbc67-d182-4b2e-8fcc-c046dd7ec152", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d248c8cc-9322-4716-96d4-524337de5598", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d98f65ee-3a21-4546-9214-964dacd4e3e0", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "79fa50c1-e1fb-47b3-a3b2-25592a8edd7a", + "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": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cd5e66cb-f3c9-4082-93a0-7f7a01a409ba", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "transforms", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "work-items", + "description": "", + "item": [ + { + "id": "3ceca7e6-9a81-437f-b004-21b825cf16b3", + "name": "List Work Items", + "request": { + "name": "List Work Items", + "description": { + "content": "This gets a collection of work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "5397380d-7ec0-47e5-9565-82dc08cd62e9", + "name": "List of work items", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"UNKNOWN\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"EXPIRED\",\n \"type\": \"CERTIFICATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cc5c5dc-9d6a-4fbe-b54b-a0e5256f29b2", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "557aea6a-3786-4a80-bb35-27f18818cb23", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c9fed114-a3c2-4d5b-bed5-bcbd0f9d1866", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f33194e9-ae8f-4807-999e-cf32aeee6898", + "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": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b5578d69-21f9-4a19-9224-6993ea0debf0", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "completed", + "description": "", + "item": [ + { + "id": "808f0b46-3195-4bb0-97eb-63afc3f12473", + "name": "Completed Work Items", + "request": { + "name": "Completed Work Items", + "description": { + "content": "This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "a40b5f98-959b-4622-bdae-0f6a224ae9e8", + "name": "List of completed work items.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"REJECTED\",\n \"type\": \"UNKNOWN\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"EXPIRED\",\n \"type\": \"CERTIFICATION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "741492f3-9f63-4cb5-9fc9-c7cf726735f6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b730c15a-4047-4c8b-8e67-ab68e35ae691", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c385c0ee-cfc6-4e98-b70d-586e1e5ffbf9", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c8b89831-691e-4653-87f6-f6d4ec03de05", + "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": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a67c7d37-a175-4a1d-a405-36d491a6cba8", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.", + "type": "text/plain" + }, + "key": "limit", + "value": "250" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "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.", + "type": "text/plain" + }, + "key": "count", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "count", + "description": "", + "item": [ + { + "id": "d59ba30f-da6e-4cfc-9327-40e460060eb5", + "name": "Count Completed Work Items", + "request": { + "name": "Count Completed Work Items", + "description": { + "content": "This gets a count of completed work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "completed", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "f75f2008-9ca0-4e44-bee5-79994f2b022e", + "name": "List of work items", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"count\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "169ed996-18b1-46fa-8e88-a90c9c57862f", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98a75a70-55fc-46b0-bee9-97354ca9a2dd", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f52d3edf-3ead-4957-94cc-d41c66614eae", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d41f0259-aba2-484d-abef-501d1d4966f1", + "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": { + "url": { + "path": [ + "work-items", + "completed", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "949be617-b63e-4927-a006-ba2a5056f7b4", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "completed", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "count", + "description": "", + "item": [ + { + "id": "d542641b-d3e0-4b64-912c-00e055c0b5b5", + "name": "Count Work Items", + "request": { + "name": "Count Work Items", + "description": { + "content": "This gets a count of work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "4ba23c98-0490-4953-94fe-a9d70ee0fdd1", + "name": "List of work items", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"count\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e3940494-c0ce-43e4-a39a-669ceaf6c075", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "120c6e1e-a35e-402e-b979-56c78d250151", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e5d19bc9-bbdb-4998-8e8f-5f19d9806877", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11a93d0c-8060-4448-babb-b7a5ec5049cb", + "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": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d4be1ed-1c37-474a-8511-3630cef4a98e", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "count" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "summary", + "description": "", + "item": [ + { + "id": "2e6d093f-3b35-4bb1-b1f1-5aa510657acf", + "name": "Work Items Summary", + "request": { + "name": "Work Items Summary", + "description": { + "content": "This gets a summary of work items belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "263ad59b-f96c-47f4-a628-d08d87b609f3", + "name": "List of work items", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"open\": \"\",\n \"completed\": \"\",\n \"total\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "03d99ba5-ff03-4d6a-84d5-3608ca29cafd", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "59b59593-de96-4bd3-826f-f65603d00c4d", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a9787fb-bc5e-4f87-93a3-b623e513582b", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5c4734c-83bd-49ca-bed3-5caf189a3e0c", + "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": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "143f261b-0d8d-4e2e-bfd9-07c02c0c570c", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "summary" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "ID of the work item owner.", + "type": "text/plain" + }, + "key": "ownerId", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "9ec1f0e2-bcfa-4420-a375-6ec65e203e93", + "name": "Get a Work Item", + "request": { + "name": "Get a Work Item", + "description": { + "content": "This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "response": [ + { + "id": "80eb979f-d484-44c9-b078-986441ad572f", + "name": "The work item with the given ID.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "739a7ced-e009-4b5a-86bb-52d8ab81f5e6", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "18124a13-6616-4730-b1f0-724767771218", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a4b51737-1829-4e8b-bdb3-ae59bf9ded96", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "225b5f0a-0eaf-4506-8a3f-e83f91e6640c", + "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": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2fab8ccc-92ba-462e-ac15-8998d8cbdf78", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "7b02f262-111b-47b0-b47d-0b1be9ee10a3", + "name": "Complete a Work Item", + "request": { + "name": "Complete a Work Item", + "description": { + "content": "This API completes a work item. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "2131ebbb-3e4e-46f0-8e0e-c37fd7d33f1b", + "name": "A WorkItems object", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "96bf8450-29c1-4100-8b82-7f2ad547cf42", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "89533348-77e2-4b66-935e-d495dfd6686e", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb369dd1-1a5d-4d8d-8405-05aa4a8231b2", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "578cf45c-0bfc-4da9-843a-08ea7b2e09b6", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9c6a67c7-1d17-46a0-8e7c-3b9243fbac45", + "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": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8f7e201a-0ac2-4364-81fc-350098a2357a", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "approve", + "description": "", + "item": [ + { + "name": "{approvalItemId}", + "description": "", + "item": [ + { + "id": "2cfa3d77-eee0-448a-a8bf-a6179dd761fb", + "name": "Approve an Approval Item", + "request": { + "name": "Approve an Approval Item", + "description": { + "content": "This API approves an Approval Item. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "approvalItemId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "c522d9aa-b19d-4c4a-b965-11029a55557b", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "864e964a-f2bc-4e35-857d-2c05bcf2ebd5", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7cc67e73-08fe-44dd-b86a-d0ec7eafb680", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f1f27229-898f-474c-8210-23c41f4d5393", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3e37c76c-3886-4a06-b519-2625b8cb09d6", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "75f5f8f0-5d63-4ea5-a309-8fdd3641c2c4", + "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": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7ed0a879-6845-4d49-ba91-42a04a479af3", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "approve", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "reject", + "description": "", + "item": [ + { + "name": "{approvalItemId}", + "description": "", + "item": [ + { + "id": "c4f8d0dd-c03a-4233-9245-677615fe38e1", + "name": "Reject an Approval Item", + "request": { + "name": "Reject an Approval Item", + "description": { + "content": "This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "approvalItemId", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "32ff6a4a-8690-4b46-a338-5c3b6c102efc", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e54f18a3-2f79-4a88-be70-2791fe2bf213", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2bae0c27-e88f-4401-871b-a0193f5c54d3", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bcf20e0c-ee44-487a-929a-3f47b133a85f", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d25332df-0f05-4af2-b16e-92e5333f3f8d", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1cbfa412-e0b3-4c12-bc4e-fa8ed357b28f", + "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": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f734d03e-f5ea-4523-8c6e-3fc3e33e1e88", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "reject", + ":approvalItemId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "submit-account-selection", + "description": "", + "item": [ + { + "id": "c785fe15-d7cc-4457-9161-b9153938cfe5", + "name": "Submit Account Selections", + "request": { + "name": "Submit Account Selections", + "description": { + "content": "This API submits account selections. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"amet8\": -85073753,\n \"cillum_0a\": \"ullamco proident veniam\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "response": [ + { + "id": "df1c7262-8a04-4eee-b969-fa4b9c44b393", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"amet8\": -85073753,\n \"cillum_0a\": \"ullamco proident veniam\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2153b9a1-a227-426a-9f9e-b5d38bea1d05", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"amet8\": -85073753,\n \"cillum_0a\": \"ullamco proident veniam\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d4877dc2-36b6-4c7d-9f37-42f5081495bb", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"amet8\": -85073753,\n \"cillum_0a\": \"ullamco proident veniam\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f3d78652-3735-463f-860a-3f5390297f9e", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"amet8\": -85073753,\n \"cillum_0a\": \"ullamco proident veniam\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "74a59efe-1e0a-4022-95f8-a1948ce70a3c", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"amet8\": -85073753,\n \"cillum_0a\": \"ullamco proident veniam\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "32cc969d-c2f9-4e9e-9966-80d32503f6fc", + "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": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"amet8\": -85073753,\n \"cillum_0a\": \"ullamco proident veniam\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "09701c78-e3e3-4ae0-bc20-14b8547b3203", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + ":id", + "submit-account-selection" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"amet8\": -85073753,\n \"cillum_0a\": \"ullamco proident veniam\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-approve", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "7b284f60-51fd-48bf-b9b7-4a4c557d05cf", + "name": "Bulk approve Approval Items", + "request": { + "name": "Bulk approve Approval Items", + "description": { + "content": "This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "c0eb3201-8b6c-45c2-89a7-642b6e324663", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "395bebb5-7d90-4d9f-9451-cc853d0d70ff", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2c246dc4-d844-4ab4-8638-2720d50a482d", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0196fdcb-97f0-49f8-80b3-2f8844b1d2a7", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ecba2503-038a-4b3f-8af3-3238053304f8", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b52b7093-3c9d-425b-844b-b0c0dac9b899", + "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": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4ea6881-16ea-4033-acfd-0941fc1e422d", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-approve", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "bulk-reject", + "description": "", + "item": [ + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "054fd3fc-a221-486f-82d4-ef5b22fa570e", + "name": "Bulk reject Approval Items", + "request": { + "name": "Bulk reject Approval Items", + "description": { + "content": "This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.", + "type": "text/plain" + }, + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "response": [ + { + "id": "e7a94cf8-5d0f-429c-9689-37002b161028", + "name": "A work items details object.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"requesterId\": \"\",\n \"requesterDisplayName\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\",\n \"state\": \"PENDING\",\n \"type\": \"MANUALACTION\",\n \"remediationItems\": {\n \"id\": \"\",\n \"targetId\": \"\",\n \"targetName\": \"\",\n \"targetDisplayName\": \"\",\n \"applicationName\": \"\",\n \"attributeName\": \"\",\n \"attributeOperation\": \"\",\n \"attributeValue\": \"\",\n \"nativeIdentity\": \"\"\n },\n \"approvalItems\": {\n \"id\": \"\",\n \"account\": \"\",\n \"application\": \"\",\n \"name\": \"\",\n \"operation\": \"\",\n \"value\": \"\",\n \"state\": \"CANCELED\"\n },\n \"name\": \"\",\n \"completed\": \"\",\n \"numItems\": \"\",\n \"form\": {\n \"id\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"targetUser\": \"\",\n \"sections\": {\n \"name\": \"\",\n \"label\": \"\"\n }\n },\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2428699a-ad36-42d4-84a7-c1698d812edb", + "name": "Client Error - Returned if the request body is invalid.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fcaaae11-c43e-4901-979e-0d9d967980e8", + "name": "Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"JWT validation failed: JWT is expired\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0fccb70d-a2b9-43bb-93b6-ab810ea46dc5", + "name": "Forbidden - Returned if the user you are running as, doesn't have access to this end-point.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bfa4cc0a-75b0-41f7-a140-9114e8db7404", + "name": "Not Found - returned if the request URL refers to a resource or object that does not exist", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "772d300d-ca3d-4b2d-9853-f4027ce4e68b", + "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": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"message\": {\n \"description\": \"A message describing the error\",\n \"example\": \" Rate Limit Exceeded \"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b986bc88-c1fb-4b81-b63f-1b1de60a84fe", + "name": "Internal Server Error - Returned if there is an unexpected error.", + "originalRequest": { + "url": { + "path": [ + "work-items", + "bulk-reject", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: oauth2", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "POST", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"detailCode\": \"\",\n \"trackingId\": \"\",\n \"messages\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"\"\n },\n {\n \"locale\": \"\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "const domain = pm.environment.get('domain') ? pm.environment.get('domain') : pm.collectionVariables.get('domain')", + "const tokenUrl = 'https://' + pm.environment.get('tenant') + '.api.' + domain + '.com/oauth/token';", + "const clientId = pm.environment.get('clientId');", + "const clientSecret = pm.environment.get('clientSecret');", + "", + "const getTokenRequest = {", + " method: 'POST',", + " url: tokenUrl,", + " body: {", + " mode: 'formdata',", + " formdata: [{", + " key: 'grant_type',", + " value: 'client_credentials'", + " },", + " {", + " key: 'client_id',", + " value: clientId", + " },", + " {", + " key: 'client_secret',", + " value: clientSecret", + " }", + " ]", + " }", + "};", + "", + "", + "var moment = require('moment');", + "if (!pm.environment.has('tokenExpTime')) {", + " pm.environment.set('tokenExpTime', moment());", + "}", + "", + "if (moment(pm.environment.get('tokenExpTime')) <= moment() || !pm.environment.get('tokenExpTime') || !pm.environment.get('accessToken')) {", + " var time = moment();", + " time.add(12, 'hours');", + " pm.environment.set('tokenExpTime', time);", + " pm.sendRequest(getTokenRequest, (err, response) => {", + " const jsonResponse = response.json();", + " if (response.code != 200) {", + " throw new Error(`Unable to authenticate: ${JSON.stringify(jsonResponse)}`);", + " }", + " const newAccessToken = jsonResponse.access_token;", + " pm.environment.set('accessToken', newAccessToken);", + " });", + "", + "}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "key": "domain", + "value": "identitynow", + "type": "string" + }, + { + "key": "baseUrl", + "value": "https://{{tenant}}.api.{{domain}}.com", + "type": "string" + } + ], + "info": { + "_postman_id": "444bdd5e-77ce-4925-8541-d0304f140641", + "name": "IdentityNow V3 API", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "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", + "type": "text/plain" + } + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{accessToken}}", + "type": "string" + } + ] + } +} \ No newline at end of file